issue #80: add settings to be able to release members from managed cohorts

Author: dmitriim

classes/cohort_manager.php

@@ -77,12 +77,19 @@ public static function manage_cohort(int $cohortid): void {
      * @param int $cohortid Cohort ID.
      */
     public static function unmanage_cohort(int $cohortid): void {
+        global $DB;
+
         $cohorts = self::get_cohorts();
 
         if (!empty($cohorts[$cohortid])) {
             $cohort = $cohorts[$cohortid];
             $cohort->component = '';
             cohort_update_cohort($cohort);
+
+            // Brutally delete members if configured to do so. No cohort_member_removed events will be triggered.
+            if (get_config('tool_dynamic_cohorts', 'releasemembers')) {
+                $DB->delete_records('cohort_members', ['cohortid' => $cohortid]);
+            }
         }
     }
 }

lang/en/tool_dynamic_cohorts.php

@@ -141,6 +141,8 @@
 $string['rule_entity.description'] = 'Description';
 $string['rule_entity.bulkprocessing'] = 'Bulk processing';
 $string['rule_entity.status'] = 'Status';
+$string['settings:releasemembers'] = 'Release members';
+$string['settings:releasemembers_desc'] = 'If enabled all members will be removed from a cohort once it\'s not managed by the plugin (e.g a rule is deleted or cohort for a rule is changed). <br/> Please note: no cohort_member_removed events will be triggered when members are released from a cohort.';
 $string['usercreated'] = 'User was created';
 $string['usercreatedin'] = 'Users who were created in the last {$a}';
 $string['usercreatedtime'] = 'Users who were created {$a->operator} {$a->time}';

settings.php

@@ -25,6 +25,18 @@
 defined('MOODLE_INTERNAL') || die();
 
 $ADMIN->add('accounts', new admin_category('tool_dynamic_cohorts', get_string('pluginname', 'tool_dynamic_cohorts')));
+
+if ($hassiteconfig) {
+    $settings = new admin_settingpage('tool_dynamic_cohorts_settings', new lang_string('settings'));
+    $settings->add(new admin_setting_configcheckbox(
+        'tool_dynamic_cohorts/releasemembers',
+        new lang_string('settings:releasemembers', 'tool_dynamic_cohorts'),
+        new lang_string('settings:releasemembers_desc', 'tool_dynamic_cohorts'),
+        0
+    ));
+    $ADMIN->add('tool_dynamic_cohorts', $settings);
+}
+
 $ADMIN->add('tool_dynamic_cohorts', new admin_externalpage(
     'tool_dynamic_cohorts_rules',
     get_string('managerules', 'tool_dynamic_cohorts'),

tests/cohort_manager_test.php

@@ -87,4 +87,33 @@ public function test_unmanage_cohort() {
         cohort_manager::unmanage_cohort($cohort->id);
         $this->assertEquals('', $DB->get_field('cohort', 'component', ['id' => $cohort->id]));
     }
+
+    /**
+     * Test un managing cohort removes members when configured.
+     */
+    public function test_unmanage_cohort_removes_members() {
+        global $DB;
+
+        $this->resetAfterTest();
+
+        $user1 = $this->getDataGenerator()->create_user();
+        $user2 = $this->getDataGenerator()->create_user();
+
+        $cohort = $this->getDataGenerator()->create_cohort(['component' => 'tool_dynamic_cohorts']);
+        cohort_add_member($cohort->id, $user1->id);
+        cohort_add_member($cohort->id, $user2->id);
+
+        $this->assertEquals('tool_dynamic_cohorts', $DB->get_field('cohort', 'component', ['id' => $cohort->id]));
+        $this->assertCount(2, $DB->get_records('cohort_members', ['cohortid' => $cohort->id]));
+
+        set_config('releasemembers', 0, 'tool_dynamic_cohorts');
+        cohort_manager::unmanage_cohort($cohort->id);
+        $this->assertEquals('', $DB->get_field('cohort', 'component', ['id' => $cohort->id]));
+        $this->assertCount(2, $DB->get_records('cohort_members', ['cohortid' => $cohort->id]));
+
+        set_config('releasemembers', 1, 'tool_dynamic_cohorts');
+        cohort_manager::unmanage_cohort($cohort->id);
+        $this->assertEquals('', $DB->get_field('cohort', 'component', ['id' => $cohort->id]));
+        $this->assertCount(0, $DB->get_records('cohort_members', ['cohortid' => $cohort->id]));
+    }
 }

version.php

@@ -25,8 +25,8 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component = 'tool_dynamic_cohorts';
-$plugin->release = 2024042000;
-$plugin->version = 2024042000;
+$plugin->release = 2024042001;
+$plugin->version = 2024042001;
 $plugin->requires = 2022112800;
 $plugin->supported = [401, 403];
 $plugin->maturity = MATURITY_STABLE;