issue #151 add feature to optionally support label by a new added setting

backup/moodle2/backup_checklist_stepslib.php

@@ -45,7 +45,7 @@ protected function define_structure() {
         $checklist = new backup_nested_element('checklist', ['id'], [
             'name', 'intro', 'introformat', 'timecreated', 'timemodified', 'useritemsallowed', 'studentcomments',
             'teacheredit', 'theme', 'duedatesoncalendar', 'teachercomments', 'maxgrade',
-            'autopopulate', 'autoupdate', 'completionpercent', 'completionpercenttype', 'emailoncomplete', 'lockteachermarks',
+            'autopopulate', 'supportlabel', 'autoupdate', 'completionpercent', 'completionpercenttype', 'emailoncomplete', 'lockteachermarks',
         ]);
 
         $items = new backup_nested_element('items');

classes/local/output_status.php

@@ -78,6 +78,8 @@ class output_status {
     protected $itemid = null;
     /** @var bool */
     protected $autopopulate = false;
+    /** @var bool */
+    protected $supportlabel = false;
     /** @var string|null */
     protected $autoupdatewarning = null;
     /** @var bool */
@@ -405,6 +407,22 @@ public function set_autopopulate($autopopulate) {
         $this->autopopulate = $autopopulate;
     }
 
+    /**
+     * Is label support enabled for this instance?
+     * @return boolean
+     */
+    public function is_supportlabel() {
+        return $this->supportlabel;
+    }
+
+    /**
+     * Set as label support enabled
+     * @param boolean $supportlabel
+     */
+    public function set_supportlabel($supportlabel) {
+        $this->supportlabel = $supportlabel;
+    }
+
     /**
      * Should the autoupdate warning be shown and, if so, what type?
      * @return int|null

db/install.xml

@@ -21,6 +21,7 @@
         <FIELD NAME="teachercomments" TYPE="int" LENGTH="4" NOTNULL="false" DEFAULT="1" SEQUENCE="false" COMMENT="Are teachers allowed to add comments to a user's checklist items?"/>
         <FIELD NAME="maxgrade" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="100" SEQUENCE="false"/>
         <FIELD NAME="autopopulate" TYPE="int" LENGTH="4" NOTNULL="false" DEFAULT="0" SEQUENCE="false" COMMENT="Automatically fill in the checklist, based on the modules in the current course"/>
+        <FIELD NAME="supportlabel" TYPE="int" LENGTH="4" NOTNULL="false" DEFAULT="0" SEQUENCE="false" COMMENT="Whether or not labels are supported"/>
         <FIELD NAME="autoupdate" TYPE="int" LENGTH="4" NOTNULL="false" DEFAULT="1" SEQUENCE="false" COMMENT="Automatically update items that are linked to course modules (tick them off when items are complete)"/>
         <FIELD NAME="completionpercent" TYPE="int" LENGTH="10" NOTNULL="false" DEFAULT="0" SEQUENCE="false" COMMENT="Percentage of items that need to be checked off before the checklist is regarded as complete"/>
         <FIELD NAME="completionpercenttype" TYPE="char" LENGTH="8" NOTNULL="true" DEFAULT="percent" SEQUENCE="false" COMMENT="Whether completionpercent represents a percentage or raw number of items"/>

db/upgrade.php

@@ -441,5 +441,17 @@ function xmldb_checklist_upgrade($oldversion = 0) {
         upgrade_mod_savepoint(true, 2022052801, 'checklist');
     }
 
+    if ($oldversion < 2026010100) {
+        $table = new xmldb_table('checklist');
+        $field = new xmldb_field('supportlabel', XMLDB_TYPE_INTEGER, '4', null, XMLDB_NOTNULL, null, '0');
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // Checklist savepoint reached.
+        upgrade_mod_savepoint(true, 2026010100, 'checklist');
+
+    }
+
     return $result;
 }

lang/en/checklist.php

@@ -193,6 +193,9 @@
 $string['student_comment_updated'] = 'Student comment updated';
 $string['student_comment_updated_desc'] = 'The user with id {$a->userid} has updated a comment in the checklist with course module id {$a->cmid} to have text \'{$a->commenttext}\'';
 $string['studentcomments'] = 'User can add their own comments to checklist items';
+$string['supportlabel'] = 'Support label';
+$string['supportlabel_help'] = 'By default label are not supported because in many cases the checklist would be very large.<br />
+If you whant also to use label in checklist, then you can activate it with this setting.';
 $string['teacheralongsidecheck'] = 'Student and teacher';
 $string['teachercomments'] = 'Teachers can add comments';
 $string['teacherdate'] = 'Date a teacher last updated this item';

locallib.php

@@ -482,12 +482,13 @@ protected function update_items_from_course() {
                 $nextpos = $this->items[$sectionheading]->position + 1;
             }
 
+            $supportlabel = $this->checklist->supportlabel;
             foreach ($sections[$section] as $cmid) {
                 if ($this->cm->id == $cmid) {
                     continue; // Do not include this checklist in the list of modules.
                 }
-                if ($mods->get_cm($cmid)->modname === 'label') {
-                    continue; // Ignore any labels.
+                if ($mods->get_cm($cmid)->modname === 'label' && !$supportlabel) {
+                        continue; // Ignore any labels.
                 }
                 if (isset($mods->get_cm($cmid)->deletioninprogress) && $mods->get_cm($cmid)->deletioninprogress) {
                     continue; // M3.2 onwards - if cm is in the recycle bin, being deleted, then skip it.

mod_form.php

@@ -94,6 +94,10 @@ public function definition() {
         $mform->setDefault('autopopulate', 0);
         $mform->addHelpButton('autopopulate', 'autopopulate', 'checklist');
 
+        $mform->addElement('select', 'supportlabel', get_string('supportlabel', 'checklist'), $ynoptions);
+        $mform->setDefault('supportlabel', 0);
+        $mform->addHelpButton('supportlabel', 'supportlabel', 'checklist');
+
         $checkdisable = true;
         $str = 'autoupdate';
         if (get_config('mod_checklist', 'linkcourses')) {

tests/generator/lib.php

@@ -49,6 +49,7 @@ public function create_instance($record = null, ?array $options = null) {
             'teachercomments' => 1,
             'maxgrade' => 100,
             'autopopulate' => CHECKLIST_AUTOPOPULATE_NO,
+            'supportlabel' => 0,
             'autoupdate' => CHECKLIST_AUTOUPDATE_YES,
             'completionpercent' => 0,
             'emailoncomplete' => 0,

version.php

@@ -24,9 +24,9 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version = 2025101800;  // The current module version (Date: YYYYMMDDXX).
+$plugin->version = 2026010100;  // The current module version (Date: YYYYMMDDXX).
 $plugin->maturity = MATURITY_STABLE;
-$plugin->release = '4.1.0.7';
+$plugin->release = '4.1.0.8';
 $plugin->requires = 2022112800; // Moodle 4.1.0.
 $plugin->component = 'mod_checklist';
 $plugin->supported = [401, 501];