smooth uninstall only with the triggers

Author: bluetom

trigger/delayedcourses/classes/privacy/provider.php

@@ -0,0 +1,40 @@
+<?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/>.
+
+namespace lifecycletrigger_delayedcourses\privacy;
+
+use core_privacy\local\metadata\null_provider;
+
+/**
+ * Privacy subsystem implementation for lifecycletrigger_delayedcourses.
+ *
+ * @package     lifecycletrigger_delayedcourses
+ * @copyright   2022 ISB Bayern
+ * @author      Philipp Memmel
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements null_provider {
+
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return string the reason
+     */
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+}

trigger/delayedcourses/lang/de/lifecycletrigger_delayedcourses.php

@@ -0,0 +1,29 @@
+<?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/>.
+
+/**
+ * Lang strings for delayed course trigger
+ *
+ * @package lifecycletrigger_delayedcourses
+ * @copyright  2017 Tobias Reischmann WWU
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['delay'] = 'Dieser Trigger wird alle Kurse ausschließen, die durch Nutzerinteraktion verzögert wurden.';
+$string['plugindescription'] = 'Schließt Kurse von diesem Workflow aus, die durch Nutzeraktion verzögert wurden.';
+$string['pluginname'] = 'Verzögerte Kurse ausschließen - Trigger';
+$string['privacy:metadata'] = 'Dieses Subplugin speichert keine persönlichen Daten.';
+

trigger/delayedcourses/lang/en/lifecycletrigger_delayedcourses.php

@@ -0,0 +1,28 @@
+<?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/>.
+
+/**
+ * Lang strings for delayed course trigger
+ *
+ * @package lifecycletrigger_delayedcourses
+ * @copyright  2017 Tobias Reischmann WWU
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['delay'] = 'This module will exclude all courses, which were delayed by user interaction';
+$string['plugindescription'] = 'Exludes all courses which were delayed by user interaction.';
+$string['pluginname'] = 'Exclude delayed courses trigger';
+$string['privacy:metadata'] = 'This subplugin does not store any personal data.';

trigger/delayedcourses/lib.php

@@ -0,0 +1,77 @@
+<?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/>.
+
+/**
+ * Trigger subplugin to exclude delayed courses.
+ *
+ * @package lifecycletrigger_delayedcourses
+ * @copyright  2017 Tobias Reischmann WWU
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace tool_lifecycle\trigger;
+
+use tool_lifecycle\local\response\trigger_response;
+use tool_lifecycle\local\manager\delayed_courses_manager;
+
+defined('MOODLE_INTERNAL') || die();
+require_once(__DIR__ . '/../lib.php');
+
+/**
+ * Class which implements the basic methods necessary for a life cycle trigger subplugin
+ * @package lifecycletrigger_delayedcourses
+ * @copyright  2017 Tobias Reischmann WWU
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class delayedcourses extends base_automatic {
+
+
+    /**
+     * Checks the course and returns a repsonse, which tells if the course should be further processed.
+     * @param object $course Course to be processed.
+     * @param int $triggerid Id of the trigger instance.
+     * @return trigger_response
+     */
+    public function check_course($course, $triggerid) {
+        return trigger_response::exclude();
+    }
+
+    /**
+     * Return sql which excludes delayed courses.
+     * @param int $triggerid Id of the trigger.
+     * @return array A list containing the constructed sql fragment and an array of parameters.
+     */
+    public function get_course_recordset_where($triggerid) {
+        return delayed_courses_manager::get_course_delayed_wheresql();
+    }
+
+
+    /**
+     * The return value should be equivalent with the name of the subplugin folder.
+     * @return string technical name of the subplugin
+     */
+    public function get_subpluginname() {
+        return 'delayedcourses';
+    }
+
+    /**
+     * Has only one instance and results in a preset workflow.
+     * @return bool
+     */
+    public function has_multiple_instances() {
+        return false;
+    }
+
+}

trigger/delayedcourses/tests/generator/lib.php

@@ -0,0 +1,101 @@
+<?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/>.
+
+/**
+ * lifecycletrigger_delayedcourses generator tests
+ *
+ * @package    lifecycletrigger_delayedcourses
+ * @category   test
+ * @copyright  2018 Tobias Reischmann WWU
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+use tool_lifecycle\local\entity\trigger_subplugin;
+use tool_lifecycle\local\entity\workflow;
+use tool_lifecycle\local\manager\trigger_manager;
+use tool_lifecycle\local\manager\workflow_manager;
+
+/**
+ * lifecycletrigger_delayedcourses generator tests
+ *
+ * @package    lifecycletrigger_delayedcourses
+ * @category   test
+ * @copyright  2018 Tobias Reischmann WWU
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class tool_lifecycle_trigger_delayedcourses_generator extends testing_module_generator {
+
+    /**
+     * Creates a trigger delayedcourses for an artificial workflow without steps.
+     * @return trigger_subplugin the created delayedcourses trigger.
+     * @throws dml_exception
+     * @throws dml_transaction_exception
+     */
+    public static function create_trigger_with_workflow() {
+        // Create Workflow.
+        $record = new stdClass();
+        $record->id = null;
+        $record->title = 'myworkflow';
+        $workflow = workflow::from_record($record);
+        workflow_manager::insert_or_update($workflow);
+        // Create trigger.
+        $record = new stdClass();
+        $record->subpluginname = 'delayedcourses';
+        $record->instancename = 'delayedcourses';
+        $record->workflowid = $workflow->id;
+        $trigger = trigger_subplugin::from_record($record);
+        trigger_manager::insert_or_update($trigger);
+        return $trigger;
+    }
+
+    /**
+     * Creates a workflow, which delays only for upcomming processes of itself.
+     * @return workflow.
+     * @throws dml_exception
+     * @throws dml_transaction_exception
+     */
+    public static function create_workflow() {
+        // Create Workflow.
+        $record = new stdClass();
+        $record->id = null;
+        $record->title = 'myworkflow';
+        $record->rollbackdelay = 10000;
+        $record->finishdelay = 10000;
+        $record->delayforallworkflows = 0;
+        $workflow = workflow::from_record($record);
+        workflow_manager::insert_or_update($workflow);
+        return $workflow;
+    }
+
+    /**
+     * Creates a workflow, which delays upcomming processes for all workflows.
+     * @return workflow.
+     * @throws dml_exception
+     * @throws dml_transaction_exception
+     */
+    public static function create_workflow_delaying_for_all_workflows() {
+        // Create Workflow.
+        $record = new stdClass();
+        $record->id = null;
+        $record->title = 'myworkflow';
+        $record->rollbackdelay = 10000;
+        $record->finishdelay = 10000;
+        $record->delayforallworkflows = 1;
+        $workflow = workflow::from_record($record);
+        workflow_manager::insert_or_update($workflow);
+        return $workflow;
+    }
+}