Assign role synchronization to course category context (#1)

classes/form/edit.php

@@ -33,6 +33,9 @@ class edit extends \core\form\persistent {
     /** @var string Persistent class name. */
     protected static $persistentclass = persistent::class;
 
+    /** @var array Fields to remove when getting the final data. */
+    protected static $fieldstoremove = array('submitbutton', 'modeid');
+
     /**
      * Form definition
      *
@@ -41,16 +44,26 @@ class edit extends \core\form\persistent {
     protected function definition() {
         $mform = $this->_form;
 
+        $mode = $this->_customdata['modeid'];
+
+        $mform->addElement('hidden', 'modeid', $mode);
+        $mform->setType('modeid', PARAM_INT);
+
         $mform->addElement('select', 'cohortid', get_string('cohort', 'local_cohortrole'), self::get_cohorts());
         $mform->addRule('cohortid', get_string('required'), 'required', null, 'client');
         $mform->setType('cohortid', PARAM_INT);
         $mform->addHelpButton('cohortid', 'cohort', 'local_cohortrole');
 
-        $mform->addElement('select', 'roleid', get_string('role', 'local_cohortrole'), self::get_roles());
+        $mform->addElement('select', 'roleid', get_string('role', 'local_cohortrole'), self::get_roles($mode));
         $mform->addRule('roleid', get_string('required'), 'required', null, 'client');
         $mform->setType('roleid', PARAM_INT);
         $mform->addHelpButton('roleid', 'role', 'local_cohortrole');
 
+        $mform->addElement('select', 'categoryid', get_string('category', 'local_cohortrole'), self::get_categories());
+        $mform->setType('categoryid', PARAM_INT);
+        $mform->addHelpButton('categoryid', 'category', 'local_cohortrole');
+        $mform->hideIf('categoryid', 'modeid', 'eq', 0);
+
         $this->add_action_buttons();
     }
 
@@ -63,8 +76,8 @@ protected function definition() {
      * @return array
      */
     public function extra_validation($data, $files, array &$errors) {
-        if ($this->get_persistent()->record_exists_select('cohortid = :cohortid AND roleid = :roleid',
-                ['cohortid' => $data->cohortid, 'roleid' => $data->roleid])) {
+        if ($this->get_persistent()->record_exists_select('cohortid = :cohortid AND roleid = :roleid AND categoryid = :categoryid',
+            ['cohortid' => $data->cohortid, 'roleid' => $data->roleid, 'categoryid' => $data->categoryid])) {
 
             $errors['cohortid'] = get_string('errorexists', 'local_cohortrole');
         }
@@ -89,15 +102,31 @@ protected static function get_cohorts() {
     }
 
     /**
-     * Get roles that are assignable in the system context
+     * Get roles that are assignable in the system or course category context
      *
+     * @param string $modeid The selected modeid (0 = System, 1 = Category)
      * @return array
      */
-    protected static function get_roles() {
-        $roles = get_assignable_roles(\context_system::instance(), ROLENAME_ALIAS);
+    protected static function get_roles($modeid) {
+        $context = local_cohortrole_get_context($modeid);
+
+        $roles = get_assignable_roles($context, ROLENAME_ALIAS);
 
         \core_collator::asort($roles, \core_collator::SORT_STRING);
 
         return $roles;
     }
+
+    /**
+     * Get categories from the system
+     *
+     * @return array
+     */
+    protected static function get_categories() {
+        $categories = [0 => get_string('choosedots')] + \core_course_category::make_categories_list();
+
+        \core_collator::asort($categories, \core_collator::SORT_STRING);
+
+        return $categories;
+    }
 }

classes/observers.php

@@ -39,12 +39,10 @@ public static function cohort_deleted(\core\event\cohort_deleted $event) {
             $cohort = $event->get_record_snapshot('cohort', $event->objectid);
 
             $instances = persistent::get_records(['cohortid' => $cohort->id]);
-            if (count($instances) > 0) {
-                local_cohortrole_unsynchronize($cohort->id);
+            foreach ($instances as $instance) {
+                local_cohortrole_unsynchronize($cohort->id, $instance->get('roleid'), $instance->get('categoryid'));
 
-                foreach ($instances as $instance) {
-                    $instance->delete();
-                }
+                $instance->delete();
             }
         }
     }
@@ -64,7 +62,8 @@ public static function cohort_member_added(\core\event\cohort_member_added $even
                 $user = \core_user::get_user($event->relateduserid, '*', MUST_EXIST);
 
                 foreach ($instances as $instance) {
-                    local_cohortrole_role_assign($instance->get('cohortid'), $instance->get('roleid'), [$user->id]);
+                    local_cohortrole_role_assign($instance->get('cohortid'), $instance->get('roleid'), $instance->get('categoryid'),
+                        [$user->id]);
                 }
             }
         }
@@ -85,7 +84,8 @@ public static function cohort_member_removed(\core\event\cohort_member_removed $
                 $user = \core_user::get_user($event->relateduserid, '*', MUST_EXIST);
 
                 foreach ($instances as $instance) {
-                    local_cohortrole_role_unassign($instance->get('cohortid'), $instance->get('roleid'), [$user->id]);
+                    local_cohortrole_role_unassign($instance->get('cohortid'), $instance->get('roleid'),
+                        $instance->get('categoryid'), [$user->id]);
                 }
             }
         }

classes/output/summary_table.php

@@ -41,6 +41,7 @@ public function __construct() {
         $columns = [
             'cohort' => get_string('cohort', 'local_cohortrole'),
             'role' => get_string('role', 'local_cohortrole'),
+            'category' => get_string('category', 'local_cohortrole'),
             'timecreated' => get_string('modified'),
             'edit' => get_string('edit'),
         ];
@@ -124,6 +125,22 @@ public function col_role(\stdClass $record) {
         return role_get_name($persistent->get_role(), \context_system::instance(), ROLENAME_ALIAS);
     }
 
+    /**
+     * Format record category column
+     *
+     * @param stdClass $record
+     * @return string
+     */
+    public function col_category(\stdClass $record) {
+        if ($record->categoryid == LOCAL_COHORTROLE_MODE_SYSTEM) {
+            return '';
+        }
+
+        $persistent = new persistent(0, $record);
+
+        return $persistent->get_category()->name;
+    }
+
     /**
      * Format record time created column
      *

classes/persistent.php

@@ -45,6 +45,9 @@ protected static function define_properties() {
             'roleid' => array(
                 'type' => PARAM_INT,
             ),
+            'categoryid' => array(
+                'type' => PARAM_INT,
+            ),
         );
     }
 
@@ -82,6 +85,26 @@ protected function validate_roleid($roleid) {
         return true;
     }
 
+    /**
+     * Validate category ID
+     *
+     * @param int $categoryid
+     * @return true|lang_string
+     */
+    protected function validate_categoryid($categoryid) {
+        global $DB;
+
+        if ($categoryid == LOCAL_COHORTROLE_MODE_SYSTEM) {
+            return true;
+        }
+
+        if (! $DB->record_exists('course_categories', ['id' => $categoryid])) {
+            return new \lang_string('invalidcategoryid', 'error');
+        }
+
+        return true;
+    }
+
     /**
      * Hook to execute after model is created
      *
@@ -122,4 +145,15 @@ public function get_role() {
 
         return $DB->get_record('role', ['id' => $this->get('roleid')], '*', MUST_EXIST);
     }
+
+    /**
+     * Returns the category object
+     *
+     * @return stdClass
+     */
+    public function get_category() {
+        global $DB;
+
+        return $DB->get_record('course_categories', ['id' => $this->get('categoryid')], '*', MUST_EXIST);
+    }
 }

db/install.xml

@@ -9,6 +9,7 @@
         <FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/>
         <FIELD NAME="cohortid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="The id of the cohort"/>
         <FIELD NAME="roleid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="The id of the role"/>
+        <FIELD NAME="categoryid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="The id of the category"/>
         <FIELD NAME="usermodified" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="The id of the user"/>
         <FIELD NAME="timecreated" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="Time the definition was created"/>
         <FIELD NAME="timemodified" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="Time the definition was modified"/>
@@ -17,10 +18,11 @@
         <KEY NAME="primary" TYPE="primary" FIELDS="id"/>
         <KEY NAME="fk_cohort" TYPE="foreign" FIELDS="cohortid" REFTABLE="cohort" REFFIELDS="id"/>
         <KEY NAME="fk_role" TYPE="foreign" FIELDS="roleid" REFTABLE="role" REFFIELDS="id"/>
+        <KEY NAME="fk_category" TYPE="foreign" FIELDS="categoryid" REFTABLE="course_categories" REFFIELDS="id"/>
         <KEY NAME="fk_user" TYPE="foreign" FIELDS="usermodified" REFTABLE="user" REFFIELDS="id"/>
       </KEYS>
       <INDEXES>
-        <INDEX NAME="uq_cohort_role" UNIQUE="true" FIELDS="cohortid, roleid" COMMENT="Cohort and role identifiers must be unique"/>
+        <INDEX NAME="uq_cohort_role" UNIQUE="true" FIELDS="cohortid, roleid, categoryid" COMMENT="Cohort, role and category identifiers must be unique"/>
       </INDEXES>
     </TABLE>
   </TABLES>

db/upgrade.php

@@ -119,5 +119,33 @@ function xmldb_local_cohortrole_upgrade($oldversion) {
         upgrade_plugin_savepoint(true, 2018121001, 'local', 'cohortrole');
     }
 
+    if ($oldversion < 2020110901) {
+        // Define field categoryid to be added to local_cohortrole.
+        $table = new xmldb_table('local_cohortrole');
+        $field = new xmldb_field('categoryid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null, 'roleid');
+
+        // Conditionally launch add field categoryid.
+        if (! $dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // Define key fk_category (foreign) to be added to local_cohortrole.
+        $key = new xmldb_key('fk_category', XMLDB_KEY_FOREIGN, array('categoryid'), 'course_categories', array('id'));
+        $dbman->add_key($table, $key);
+
+        // Conditionally launch drop and add index 'uq_cohort_role'.
+        $index = new xmldb_index('uq_cohort_role', XMLDB_INDEX_UNIQUE, array('cohortid', 'roleid'));
+
+        if ($dbman->index_exists($table, $index)) {
+            $dbman->drop_index($table, $index);
+        }
+
+        $index = new xmldb_index('uq_cohort_role', XMLDB_INDEX_UNIQUE, array('cohortid', 'roleid', 'categoryid'));
+        $dbman->add_index($table, $index);
+
+        // Cohortrole savepoint reached.
+        upgrade_plugin_savepoint(true, 2020110901, 'local', 'cohortrole');
+    }
+
     return true;
 }

edit.php

@@ -26,19 +26,20 @@
 
 use \local_cohortrole\persistent;
 
-$delete   = optional_param('delete', 0, PARAM_INT);
-$confirm  = optional_param('confirm', 0, PARAM_BOOL);
+$delete = optional_param('delete', 0, PARAM_INT);
+$confirm = optional_param('confirm', 0, PARAM_BOOL);
+$mode = optional_param('mode', 0, PARAM_INT);
 
 admin_externalpage_setup('local_cohortrole');
 
-$editurl   = new moodle_url('/local/cohortrole/edit.php');
+$editurl = new moodle_url('/local/cohortrole/edit.php');
 $returnurl = clone($PAGE->url);
 
 if ($delete) {
     $persistent = new persistent($delete);
 
     if ($confirm and confirm_sesskey()) {
-        local_cohortrole_unsynchronize($persistent->get('cohortid'), $persistent->get('roleid'));
+        local_cohortrole_unsynchronize($persistent->get('cohortid'), $persistent->get('roleid'), $persistent->get('categoryid'));
 
         $persistent->delete();
 
@@ -58,14 +59,14 @@
     die;
 }
 
-$mform = new \local_cohortrole\form\edit($editurl, ['persistent' => null]);
+$mform = new \local_cohortrole\form\edit($editurl, ['persistent' => null, 'modeid' => $mode]);
 
 if ($mform->is_cancelled()) {
     redirect($returnurl);
 } else if ($data = $mform->get_data()) {
     $persistent = (new persistent(0, $data))->create();
 
-    local_cohortrole_synchronize($persistent->get('cohortid'), $persistent->get('roleid'));
+    local_cohortrole_synchronize($persistent->get('cohortid'), $persistent->get('roleid'), $persistent->get('categoryid'));
 
     redirect($returnurl, get_string('notificationcreated', 'local_cohortrole'), null,
         \core\output\notification::NOTIFY_SUCCESS);
@@ -74,7 +75,7 @@
 $PAGE->navbar->add(get_string('add'));
 
 echo $OUTPUT->header();
-echo $OUTPUT->heading(get_string('heading_add', 'local_cohortrole'));
+echo $OUTPUT->heading(get_string('heading_add', 'local_cohortrole', local_cohortrole_get_context_name($mode)));
 
 $mform->display();
 

index.php

@@ -22,6 +22,7 @@
 
 require(__DIR__ . '/../../config.php');
 require_once($CFG->libdir . '/adminlib.php');
+require_once($CFG->dirroot . '/local/cohortrole/locallib.php');
 
 admin_externalpage_setup('local_cohortrole');
 
@@ -33,6 +34,6 @@
 
 echo $PAGE->get_renderer('local_cohortrole')->render($table);
 
-echo $OUTPUT->single_button(new moodle_url('/local/cohortrole/edit.php'), get_string('add'), 'get', ['class' => 'continuebutton']);
+echo local_cohortrole_render_add_buttons();
 
 echo $OUTPUT->footer();

lang/en/local_cohortrole.php

@@ -28,7 +28,7 @@
 $string['errorexists'] = 'Synchronization already defined';
 $string['eventdefinitioncreated'] = 'Cohort role synchronization created';
 $string['eventdefinitiondeleted'] = 'Cohort role synchronization deleted';
-$string['heading_add'] = 'Define new synchronization';
+$string['heading_add'] = 'Define new synchronization in {$a}';
 $string['heading_delete'] = 'Delete defined synchronization';
 $string['heading_index'] = 'Currently defined synchronization';
 $string['notificationcreated'] = 'Created new synchronization';
@@ -40,4 +40,6 @@
 $string['privacy:metadata:cohortrole:usermodified'] = 'The ID of the user who created the definition';
 $string['privacy:metadata:cohortrole:timecreated'] = 'The timestamp the definition was created';
 $string['role'] = 'Role';
-$string['role_help'] = 'List of assignable roles in the system context';
+$string['role_help'] = 'List of assignable roles in the selected mode context';
+$string['category'] = 'Category';
+$string['category_help'] = 'You can optionally select a course category to assign roles not in the system context';