MDL-69615 core_task: Add a task trait

2024-01-15 11:24:02 +07:00
parent 076379a485
commit 99f60697ec
1 changed files with 40 additions and 0 deletions
@@ -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 core\task;
+
+/**
+ * This file defines a trait to assist with unit tests in tasks.
+ *
+ * @package    core
+ * @copyright  2024 Huong Nguyen <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+trait task_trait {
+
+    /**
+     * Helper to execute a particular task.
+     *
+     * @param string $taskclass The task class.
+     */
+    protected function execute_task(string $taskclass): void {
+        // Run the scheduled task.
+        ob_start();
+        $task = manager::get_scheduled_task($taskclass);
+        $task->execute();
+        ob_end_clean();
+    }
+}