fix settings problems, subplugin descriptions, version.php of subplugins, counters in the tabs

Author: bluetom

CHANGES.md

@@ -0,0 +1,8 @@
+CHANGELOG
+=========
+
+4.5.0 (2025-03-13)
+------------------
+* [FEATURE]
+* [FIXED]
+* Moodle 4.5 compatible version

classes/local/form/form_trigger_instance.php

@@ -101,6 +101,8 @@ public function __construct($url, $workflowid, $trigger = null, $subpluginname =
      * Defines forms elements
      */
     public function definition() {
+        global $OUTPUT;
+
         $mform = $this->_form;
 
         $mform->addElement('hidden', 'id'); // Save the record's id.

classes/tabs.php

@@ -40,34 +40,90 @@ class tabs {
      * @throws \coding_exception
      * @throws moodle_exception
      */
-    public static function get_tabrow() {
+    public static function get_tabrow($activelink = false, $deactivatelink = false, $draftlink = false) {
+        global $DB;
 
-        $targeturl = new \moodle_url('/admin/settings.php', ['section' => 'lifecycle']);
+        $classnotnull = 'badge badge-primary badge-pill ml-1';
+        $classnull = 'badge badge-secondary badge-pill ml-1';
+
+        // Get number of drafts.
+        $sql = "select count(id)
+        from {tool_lifecycle_workflow}
+        where timeactive IS NULL AND timedeactive IS NULL";
+        $i = $DB->count_records_sql($sql);
+        $drafts = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // Get number of active workflows.
+        $sql = "select count(id)
+        from {tool_lifecycle_workflow}
+        where timeactive IS NOT NULL";
+        $i = $DB->count_records_sql($sql);
+        $activewf = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // Get number of deactivated workflows.
+        $sql = "select count(id)
+        from {tool_lifecycle_workflow}
+        where timeactive IS NULL AND timedeactive IS NOT NULL";
+        $i = $DB->count_records_sql($sql);
+        $deactivatedewf = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // Get number of delayed courses.
+        $sql = "select count(id)
+        from {tool_lifecycle_delayed}";
+        $i = $DB->count_records_sql($sql);
+        $delayedcourses = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // Get number of lifecycle course backups.
+        $sql = "select count(id)
+        from {tool_lifecycle_backups}";
+        $i = $DB->count_records_sql($sql);
+        $coursebackups = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // Get number of stores lifecycle errors.
+        $sql = "select count(id)
+        from {tool_lifecycle_proc_error}";
+        $i = $DB->count_records_sql($sql);
+        $lcerrors = \html_writer::span($i, $i > 0 ? $classnotnull : $classnull);
+
+        // General Settings and Subplugins.
+        $targeturl = new \moodle_url('/admin/category.php', ['category' => 'lifecycle']);
         $tabrow[] = new \tabobject('settings', $targeturl,
             get_string('general_config_header', 'tool_lifecycle'));
 
+        // Tab to the draft workflows page.
         $targeturl = new \moodle_url('/admin/tool/lifecycle/workflowdrafts.php', ['id' => 'workflowdrafts']);
         $tabrow[] = new \tabobject('workflowdrafts', $targeturl,
-            get_string('workflow_drafts_header', 'tool_lifecycle'));
+            get_string('workflow_drafts_header', 'tool_lifecycle').$drafts,
+            get_string('workflow_drafts_header', 'tool_lifecycle'), $draftlink);
 
+        // Tab to the active workflows page.
         $targeturl = new \moodle_url('/admin/tool/lifecycle/activeworkflows.php', ['id' => 'activeworkflows']);
         $tabrow[] = new \tabobject('activeworkflows', $targeturl,
-            get_string('active_workflows_header', 'tool_lifecycle'));
+            get_string('active_workflows_header', 'tool_lifecycle').$activewf,
+            get_string('active_workflows_header', 'tool_lifecycle'), $activelink);
 
+        // Tab to the deactivated workflows page.
         $targeturl = new \moodle_url('/admin/tool/lifecycle/deactivatedworkflows.php', ['id' => 'deactivatedworkflows']);
         $tabrow[] = new \tabobject('deactivatedworkflows', $targeturl,
-            get_string('deactivated_workflows_header', 'tool_lifecycle'));
-
-        $targeturl = new \moodle_url('/admin/tool/lifecycle/coursebackups.php', ['id' => 'coursebackups']);
-        $tabrow[] = new \tabobject('coursebackups', $targeturl,
-            get_string('course_backups_list_header', 'tool_lifecycle'));
+            get_string('deactivated_workflows_header', 'tool_lifecycle').$deactivatedewf,
+            get_string('deactivated_workflows_header', 'tool_lifecycle'), $deactivatelink);
 
+        // Tab to the delayed courses list page.
         $targeturl = new \moodle_url('/admin/tool/lifecycle/delayedcourses.php', ['id' => 'delayedcourses']);
         $tabrow[] = new \tabobject('delayedcourses', $targeturl,
+            get_string('delayed_courses_header', 'tool_lifecycle').$delayedcourses,
             get_string('delayed_courses_header', 'tool_lifecycle'));
 
+        // Tab to the course backups list page.
+        $targeturl = new \moodle_url('/admin/tool/lifecycle/coursebackups.php', ['id' => 'coursebackups']);
+        $tabrow[] = new \tabobject('coursebackups', $targeturl,
+            get_string('course_backups_list_header', 'tool_lifecycle').$coursebackups,
+            get_string('course_backups_list_header', 'tool_lifecycle'));
+
+        // Tab to the lifecycle errors page.
         $targeturl = new \moodle_url('/admin/tool/lifecycle/errors.php', ['id' => 'errors']);
         $tabrow[] = new \tabobject('errors', $targeturl,
+            get_string('process_errors_header', 'tool_lifecycle').$lcerrors,
             get_string('process_errors_header', 'tool_lifecycle'));
 
         return $tabrow;

lang/de/tool_lifecycle.php

@@ -150,7 +150,7 @@
 $string['step_settings_header'] = 'Einstellungen des Schritts';
 $string['step_show'] = 'Anzeigen';
 $string['step_sortindex'] = 'Hoch/Runter';
-$string['step_subpluginname'] = 'Subpluginname';
+$string['step_subpluginname'] = 'Schritt Typ';
 $string['step_subpluginname_help'] = 'Name des Schritt/Trigger-Subplugins (nur für Admins sichtbar).';
 $string['step_type'] = 'Typ';
 $string['steps_installed'] = 'Installierte Schritt-Subplugins';
@@ -172,7 +172,7 @@
 $string['trigger_instancename_help'] = 'Titel der Trigger-Instanz (nur sichtbar für Admins).';
 $string['trigger_settings_header'] = 'Einstellungen des Triggers';
 $string['trigger_sortindex'] = 'Hoch/Runter';
-$string['trigger_subpluginname'] = 'Subplugin Name';
+$string['trigger_subpluginname'] = 'Trigger Typ';
 $string['trigger_subpluginname_help'] = 'Name des Schritt/Trigger-Subplugins (nur für Admins sichtbar).';
 $string['trigger_workflow'] = 'Workflow';
 $string['triggers_installed'] = 'Installierte Trigger';

lang/en/tool_lifecycle.php

@@ -182,7 +182,7 @@
 $string['step_settings_header'] = 'Settings of the step';
 $string['step_show'] = 'Show';
 $string['step_sortindex'] = 'Up/Down';
-$string['step_subpluginname'] = 'Subplugin name';
+$string['step_subpluginname'] = 'Step type';
 $string['step_subpluginname_help'] = 'Step subplugin/trigger title (visible for admins only).';
 $string['step_type'] = 'Type';
 $string['steps_installed'] = 'Installed Steps';
@@ -204,7 +204,7 @@
 $string['trigger_instancename_help'] = 'Trigger instance title (visible for admins only).';
 $string['trigger_settings_header'] = 'Settings of the trigger';
 $string['trigger_sortindex'] = 'Up/Down';
-$string['trigger_subpluginname'] = 'Subplugin name';
+$string['trigger_subpluginname'] = 'Trigger type';
 $string['trigger_subpluginname_help'] = 'Step subplugin/trigger title (visible for admins only).';
 $string['trigger_workflow'] = 'Workflow';
 $string['triggers_installed'] = 'Installed Triggers';

settings.php

@@ -33,6 +33,11 @@
     $triggers = core_component::get_plugin_list('lifecycletrigger');
     $steps = core_component::get_plugin_list('lifecyclestep');
 
+    $ADMIN->add('tools', new admin_category('lifecycle',
+        get_string('pluginname', 'tool_lifecycle')));
+    $settings = new admin_settingpage('lifecycle_settings',
+        get_string('general_config_header', 'tool_lifecycle'));
+
     if (!$ADMIN->fulltree) {
         $stepsortriggersettings = false;
         // Check if there are trigger settings pages.
@@ -44,7 +49,7 @@
                 }
             }
         }
-        // If no trigger settings pages check if there are step settings pages.
+        // Check if there are step settings pages.
         if (!$stepsortriggersettings && $steps) {
             foreach ($steps as $step => $path) {
                 if (file_exists($settingsfile = $path . '/settings.php')) {
@@ -54,10 +59,6 @@
             }
         }
         if ($stepsortriggersettings) {
-            $settings->add(new admin_category('lifecycle',
-                get_string('pluginname', 'tool_lifecycle')
-            ));
-            $settings->add('lifecycle', admin_settingpage('lifecycle', get_string('general_config_header', 'tool_lifecycle')));
             // Include settings page of each trigger subplugin, if there is one.
             if ($triggers) {
                 foreach ($triggers as $trigger => $path) {
@@ -74,9 +75,6 @@
                     }
                 }
             }
-        } else {
-            $settings = new admin_settingpage('lifecycle', get_string('pluginname', 'tool_lifecycle'));
-            $ADMIN->add('tools', $settings);
         }
     } else {  // No fulltree, settings detail page.
         $tabrow = tabs::get_tabrow();
@@ -85,7 +83,6 @@
         $output = print_tabs($tabs, $id, null, null, true);
 
         // Main config page.
-        $settings = new admin_settingpage('lifecycle', get_string('pluginname', 'tool_lifecycle'));
         $settings->add(new admin_setting_heading('lifecycle_settings_heading',
             $output,  html_writer::span(get_string('general_settings_header', 'tool_lifecycle'), 'h3')));
         $settings->add(new admin_setting_configduration('tool_lifecycle/duration',
@@ -106,7 +103,8 @@
                 get_string('triggers_installed', 'tool_lifecycle'), ''));
             foreach ($triggers as $trigger => $path) {
                 $settings->add(new admin_setting_description('lifecycletriggersetting_'.$trigger,
-                    get_string('pluginname', 'lifecycletrigger_' . $trigger), ''));
+                    get_string('pluginname', 'lifecycletrigger_' . $trigger),
+                    get_string('plugindescription', 'lifecycletrigger_' . $trigger)));
             }
         } else {
             $settings->add(new admin_setting_heading('adminsettings_notriggers',
@@ -118,12 +116,13 @@
                 get_string('steps_installed', 'tool_lifecycle'), ''));
             foreach ($steps as $step => $path) {
                 $settings->add(new admin_setting_description('lifecyclestepsetting_'.$step,
-                    get_string('pluginname', 'lifecyclestep_' . $step), ''));
+                    get_string('pluginname', 'lifecyclestep_' . $step),
+                    get_string('plugindescription', 'lifecyclestep_' . $step)));
             }
         } else {
             $settings->add(new admin_setting_heading('adminsettings_nosteps',
                 get_string('adminsettings_nosteps', 'tool_lifecycle'), ''));
         }
-        $ADMIN->add('tools', $settings);
+        $ADMIN->add('lifecycle', $settings);
     }
 }

step/createbackup/db/upgrade.php

@@ -53,4 +53,5 @@ function xmldb_lifecyclestep_createbackup_upgrade($oldversion) {
         upgrade_plugin_savepoint(true, 2019052900, 'lifecyclestep', 'createbackup');
     }
 
+    return true;
 }

step/createbackup/lang/de/lifecyclestep_createbackup.php

@@ -23,6 +23,7 @@
  */
 
 $string['maximumbackupspercron'] = 'Maximale Anzahl an Sicherungen per cron';
+$string['plugindescription'] = 'Stößt ein Backup der getriggerten Kursen an.';
 $string['pluginname'] = 'Kurssicherungs-Schritt';
 $string['privacy:metadata'] = 'Dieses Subplugin speichert keine persönlichen Daten.';
 

step/createbackup/lang/en/lifecyclestep_createbackup.php

@@ -23,6 +23,7 @@
  */
 
 $string['maximumbackupspercron'] = 'Maximum number of backups per cron';
+$string['plugindescription'] = 'Initiates a backup of the triggered courses.';
 $string['pluginname'] = 'Create backup step';
 $string['privacy:metadata'] = 'This subplugin does not store any personal data.';
 

step/createbackup/version.php

@@ -18,11 +18,12 @@
  * Life Cycle Create Backup Step
  *
  * @package lifecyclestep_createbackup
- * @copyright  2017 Tobias Reischmann WWU
+ * @copyright  2025 Thomas Niedermaier Universität Münster
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die;
 
-$plugin->version  = 2019052900;
+$plugin->version = 2025031300;
+$plugin->requires = 2024100700; // Requires Moodle 4.5+.
 $plugin->component = 'lifecyclestep_createbackup';