Add a comfiguration to limit the number of courses deleted per cron

step/deletecourse/db/upgrade.php

+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Update script for lifecycles subplugin deletecourse
+ *
+ * @package tool_lifecycle_step
+ * @subpackage deletecourse
+ * @copyright  2018 Tobias Reischmann WWU
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+use tool_lifecycle\manager\settings_manager;
+use tool_lifecycle\manager\step_manager;
+
+defined('MOODLE_INTERNAL') || die();
+
+function xmldb_lifecyclestep_deletecourse_upgrade($oldversion) {
+
+    if ($oldversion < 2018122300) {
+
+        $coursedeletesteps = step_manager::get_step_instances_by_subpluginname('deletecourse');
+
+        $settingsname = 'maximumdeletionspercron';
+        $settingsvalue = 10;
+        foreach ($coursedeletesteps as $step) {
+            if (empty(settings_manager::get_settings($step->id, 'step'))) {
+                settings_manager::save_settings($step->id, 'step', 'deletecourse',
+                    array($settingsname => $settingsvalue));
+            }
+        }
+
+        // Deletecourse savepoint reached.
+        upgrade_plugin_savepoint(true, 2018122300, 'lifecyclestep', 'deletecourse');
+    }
+
+}

step/deletecourse/lang/en/lifecyclestep_deletecourse.php

@@ -24,3 +24,5 @@
  */
 
 $string['pluginname'] = 'Delete Course Step';
+
+$string['deletecourse_maximumdeletionspercron'] = 'Maximum number of courses deleted per cron';

step/deletecourse/lib.php

@@ -25,6 +25,7 @@
  */
 namespace tool_lifecycle\step;
 
+use tool_lifecycle\manager\settings_manager;
 use tool_lifecycle\response\step_response;
 
 defined('MOODLE_INTERNAL') || die();
@@ -33,6 +34,7 @@ require_once(__DIR__ . '/../lib.php');
 
 class deletecourse extends libbase {
 
+    private static $numberofdeletions = 0;
 
     /**
      * Processes the course and returns a repsonse.
@@ -46,11 +48,29 @@ class deletecourse extends libbase {
      * @return step_response
      */
     public function process_course($processid, $instanceid, $course) {
+        if (self::$numberofdeletions >= settings_manager::get_settings(
+            $instanceid, SETTINGS_TYPE_STEP)['maximumdeletionspercron']) {
+            return step_response::waiting(); // Wait with further deletions til the next cron run.
+        }
         delete_course($course->id, true);
+        self::$numberofdeletions++;
         return step_response::proceed();
     }
 
     public function get_subpluginname() {
         return 'deletecourse';
     }
+
+    public function instance_settings() {
+        return array(
+            new instance_setting('maximumdeletionspercron', PARAM_INT),
+        );
+    }
+
+    public function extend_add_instance_form_definition($mform) {
+        $elementname = 'maximumdeletionspercron';
+        $mform->addElement('text', $elementname, get_string('deletecourse_maximumdeletionspercron', 'lifecyclestep_deletecourse'));
+        $mform->setType($elementname, PARAM_INT);
+        $mform->setDefault($elementname, 10);
+    }
 }

step/deletecourse/version.php

@@ -25,5 +25,5 @@
 
 defined('MOODLE_INTERNAL') || die;
 
-$plugin->version  = 2017050901;
+$plugin->version  = 2018122300;
 $plugin->component = 'lifecyclestep_deletecourse';
\ No newline at end of file