fixed phpdocs package and improved author link
[moodle.git] / cohort / lib.php
index 35d11e7..1b89be3 100644 (file)
@@ -18,9 +18,9 @@
 /**
  * Cohort related management functions, this file needs to be included manually.
  *
 /**
  * Cohort related management functions, this file needs to be included manually.
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage cohort
  * @subpackage cohort
- * @copyright  2010 Petr Skoda  (info@skodak.org)
+ * @copyright  2010 Petr Skoda  {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
@@ -28,25 +28,56 @@ require_once($CFG->dirroot . '/user/selector/lib.php');
 
 /**
  * Add new cohort.
 
 /**
  * Add new cohort.
- * @param  object $data
- * @return void
+ *
+ * @param  object $cohort
+ * @return int
  */
  */
-function cohort_add_cohort($data) {
+function cohort_add_cohort($cohort) {
     global $DB;
     global $DB;
-    $data->timecreated = time();
-    $data->timemodified = $data->timecreated;
-    $DB->insert_record('cohort', $data);
+
+    if (!isset($cohort->name)) {
+        throw new coding_exception('Missing cohort name in cohort_add_cohort().');
+    }
+    if (!isset($cohort->idnumber)) {
+        $cohort->idnumber = NULL;
+    }
+    if (!isset($cohort->description)) {
+        $cohort->description = $DB->sql_empty();
+    }
+    if (!isset($cohort->descriptionformat)) {
+        $cohort->descriptionformat = FORMAT_HTML;
+    }
+    if (empty($cohort->component)) {
+        $cohort->component = '';
+    }
+    if (!isset($cohort->timecreated)) {
+        $cohort->timecreated = time();
+    }
+    if (!isset($cohort->timemodified)) {
+        $cohort->timemodified = $cohort->timecreated;
+    }
+
+    $cohort->id = $DB->insert_record('cohort', $cohort);
+
+    events_trigger('cohort_added', $cohort);
+
+    return $cohort->id;
 }
 
 /**
  * Update existing cohort.
 }
 
 /**
  * Update existing cohort.
- * @param  object $data
+ * @param  object $cohort
  * @return void
  */
  * @return void
  */
-function cohort_update_cohort($data) {
+function cohort_update_cohort($cohort) {
     global $DB;
     global $DB;
-    $data->timemodified = time();
-    $DB->update_record('cohort', $data);
+    if (isset($cohort->component) and empty($cohort->component)) {
+        $cohort->component = NULL;
+    }
+    $cohort->timemodified = time();
+    $DB->update_record('cohort', $cohort);
+
+    events_trigger('cohort_updated', $cohort);
 }
 
 /**
 }
 
 /**
@@ -63,6 +94,8 @@ function cohort_delete_cohort($cohort) {
 
     $DB->delete_records('cohort_members', array('cohortid'=>$cohort->id));
     $DB->delete_records('cohort', array('id'=>$cohort->id));
 
     $DB->delete_records('cohort_members', array('cohortid'=>$cohort->id));
     $DB->delete_records('cohort', array('id'=>$cohort->id));
+
+    events_trigger('cohort_deleted', $cohort);
 }
 
 /**
 }
 
 /**
@@ -104,6 +137,8 @@ function cohort_add_member($cohortid, $userid) {
     $record->userid    = $userid;
     $record->timeadded = time();
     $DB->insert_record('cohort_members', $record);
     $record->userid    = $userid;
     $record->timeadded = time();
     $DB->insert_record('cohort_members', $record);
+
+    events_trigger('cohort_member_added', (object)array('cohortid'=>$cohortid, 'userid'=>$userid));
 }
 
 /**
 }
 
 /**
@@ -115,6 +150,44 @@ function cohort_add_member($cohortid, $userid) {
 function cohort_remove_member($cohortid, $userid) {
     global $DB;
     $DB->delete_records('cohort_members', array('cohortid'=>$cohortid, 'userid'=>$userid));
 function cohort_remove_member($cohortid, $userid) {
     global $DB;
     $DB->delete_records('cohort_members', array('cohortid'=>$cohortid, 'userid'=>$userid));
+
+    events_trigger('cohort_member_removed', (object)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;
 }
 
 /**
 }
 
 /**
@@ -164,8 +237,7 @@ class cohort_candidate_selector extends user_selector_base {
 
         if ($search) {
             $groupname = get_string('potusersmatching', 'cohort', $search);
 
         if ($search) {
             $groupname = get_string('potusersmatching', 'cohort', $search);
-        }
-        else {
+        } else {
             $groupname = get_string('potusers', 'cohort');
         }
 
             $groupname = get_string('potusers', 'cohort');
         }
 
@@ -227,14 +299,13 @@ class cohort_existing_selector extends user_selector_base {
 
         if ($search) {
             $groupname = get_string('currentusersmatching', 'cohort', $search);
 
         if ($search) {
             $groupname = get_string('currentusersmatching', 'cohort', $search);
-        }
-        else {
+        } else {
             $groupname = get_string('currentusers', 'cohort');
         }
 
         return array($groupname => $availableusers);
     }
             $groupname = get_string('currentusers', 'cohort');
         }
 
         return array($groupname => $availableusers);
     }
-    
+
     protected function get_options() {
         $options = parent::get_options();
         $options['cohortid'] = $this->cohortid;
     protected function get_options() {
         $options = parent::get_options();
         $options['cohortid'] = $this->cohortid;