Introduction of max_modules setting

block_completion_progress.php

@@ -243,6 +243,18 @@ protected function prepare_dashboard_content(&$barinstances) {
     protected function prepare_course_content(&$barinstances) {
         global $USER, $COURSE, $CFG, $OUTPUT;
 
+        $moduleinfo = get_fast_modinfo($COURSE);
+
+        $maxmodules = (int)get_config('block_completion_progress', 'max_modules');
+        $modules = count($moduleinfo->get_cms());
+        if ($maxmodules !== 0 && $modules > $maxmodules) {
+            $this->content->text .= get_string('too_many_modules', 'block_completion_progress', (object)[
+                'maxmodules' => $maxmodules,
+                'modules' => $modules,
+            ]);
+            return false;
+        }
+
         $output = $this->page->get_renderer('block_completion_progress');
 
         // Check if user is in group for block.

lang/en/block_completion_progress.php

@@ -25,6 +25,9 @@
 $string['completed_colour'] = '#73A839';
 $string['completed_colour_descr'] = 'HTML Colour code for elements that have been completed';
 $string['completed_colour_title'] = 'Completed colour';
+$string['too_many_modules'] = '<i class="fa fa-exclamation-circle text-danger fa-fw"></i>Too many modules to display.<br> {$a->maxmodules} modules are allowed, this course has {$a->modules}.';
+$string['max_modules'] = 'The amount of modules allowed in a course for the block to show completion progress';
+$string['max_modules_desc'] = 'If the course has more modules than this, the block will not show completion progress. <strong>By setting this setting to 0, the block will always show completion progress.</strong>';
 $string['completion_not_enabled'] = 'Completion tracking is not enabled on this site.';
 $string['completion_not_enabled_course'] = 'Completion tracking is not enabled in this course.';
 $string['completion_progress:addinstance'] = 'Add a new Completion Progress block';

settings.php

@@ -102,8 +102,17 @@
         defaults::SHOWLASTINCOURSE)
     );
     $settings->add(new admin_setting_configcheckbox('block_completion_progress/forceiconsinbar',
-        get_string('forceiconsinbar', 'block_completion_progress'),
-        '',
-        defaults::FORCEICONSINBAR)
+            get_string('forceiconsinbar', 'block_completion_progress'),
+            '',
+            defaults::FORCEICONSINBAR)
+    );
+    $settings->add(
+        new admin_setting_configtext(
+            'block_completion_progress/max_modules',
+            get_string('max_modules', 'block_completion_progress'),
+            get_string('max_modules_desc', 'block_completion_progress'),
+        0,
+        PARAM_INT
+        )
     );
 }

version.php

@@ -25,8 +25,9 @@
 
 defined('MOODLE_INTERNAL') || die;
 
-$plugin->version   = 2023110100;
+/** @var object $plugin */
+$plugin->component = 'block_completion_progress';
+$plugin->version   = 2023110101;
 $plugin->requires  = 2022112800;
 $plugin->maturity  = MATURITY_STABLE;
 $plugin->release   = 'Version for Moodle 4.1 onwards';
-$plugin->component = 'block_completion_progress';