MDL-21781 added support for autocreation of groups from cohorts
[moodle.git] / cohort / lib.php
index 2eda91d..176093d 100644 (file)
@@ -65,6 +65,32 @@ function cohort_delete_cohort($cohort) {
     $DB->delete_records('cohort', array('id'=>$cohort->id));
 }
 
+/**
+ * Somehow deal with cohorts when deleting course category,
+ * we can not just delete them because they might be used in enrol
+ * plugins or referenced in external systems.
+ * @param  object $category
+ * @return void
+ */
+function cohort_delete_category($category) {
+    global $DB;
+    // TODO: make sure that cohorts are really, really not used anywhere and delete, for now just move to parent or system context
+
+    $oldcontext = get_context_instance(CONTEXT_COURSECAT, $category->id, MUST_EXIST);
+
+    if ($category->parent and $parent = $DB->get_record('course_categories', array('id'=>$category->parent))) {
+        $parentcontext = get_context_instance(CONTEXT_COURSECAT, $parent->id, MUST_EXIST);
+        $sql = "UPDATE {cohort} SET contextid = :newcontext WHERE contextid = :oldcontext";
+        $params = array('oldcontext'=>$oldcontext->id, 'newcontext'=>$parentcontext->id);
+    } else {
+        $syscontext = get_context_instance(CONTEXT_SYSTEM);
+        $sql = "UPDATE {cohort} SET contextid = :newcontext WHERE contextid = :oldcontext";
+        $params = array('oldcontext'=>$oldcontext->id, 'newcontext'=>$syscontext->id);
+    }
+
+    $DB->execute($sql, $params);
+}
+
 /**
  * Remove cohort member
  * @param  int $cohortid
@@ -91,6 +117,42 @@ function cohort_remove_member($cohortid, $userid) {
     $DB->delete_records('cohort_members', array('cohortid'=>$cohortid, 'userid'=>$userid));
 }
 
+/**
+ * Returns list of visible cohorts in course.
+ *
+ * @param  object $course
+ * @param  bool $enrolled true means include only cohorts with enrolled users
+ * @return array
+ */
+function cohort_get_visible_list($course) {
+    global $DB, $USER;
+
+    $context = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
+    list($esql, $params) = get_enrolled_sql($context);
+    $parentsql = get_related_contexts_string($context);
+
+    $sql = "SELECT c.id, c.name, c.idnumber, COUNT(u.id) AS cnt
+              FROM {cohort} c
+              JOIN {cohort_members} cm ON cm.cohortid = c.id
+              JOIN ($esql) u ON u.id = cm.userid
+             WHERE c.contextid $parentsql
+          GROUP BY c.id, c.name, c.idnumber
+            HAVING COUNT(u.id) > 0
+          ORDER BY c.name, c.idnumber";
+    $params['ctx'] = $context->id;
+
+    $cohorts = $DB->get_records_sql($sql, $params);
+
+    foreach ($cohorts as $cid=>$cohort) {
+        $cohorts[$cid] = format_string($cohort->name);
+        if ($cohort->idnumber) {
+            $cohorts[$cid] .= ' (' . $cohort->cnt . ')';
+        }
+    }
+
+    return $cohorts;
+}
+
 /**
  * Cohort assignment candidates
  */
@@ -149,6 +211,7 @@ class cohort_candidate_selector extends user_selector_base {
     protected function get_options() {
         $options = parent::get_options();
         $options['cohortid'] = $this->cohortid;
+        $options['file'] = 'cohort/lib.php';
         return $options;
     }
 }
@@ -211,6 +274,7 @@ class cohort_existing_selector extends user_selector_base {
     protected function get_options() {
         $options = parent::get_options();
         $options['cohortid'] = $this->cohortid;
+        $options['file'] = 'cohort/lib.php';
         return $options;
     }
 }