Newer
Older
<?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/>.
/**
* Manager for Cleanup Course Processes
*
* @package tool_cleanupcourses
* @copyright 2017 Tobias Reischmann WWU
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace tool_cleanupcourses\manager;
use tool_cleanupcourses\entity\process;
use tool_cleanupcourses\entity\trigger_subplugin;
use tool_cleanupcourses\manager\delayed_courses_manager;
defined('MOODLE_INTERNAL') || die();
class process_manager {
/**
* Creates a process for the course for a certain workflow.
* @param int $courseid id of the course
* @param int $workflowid id of the workflow
public static function create_process($courseid, $workflowid) {
global $DB;
if ($workflowid !== null) {
$record = new \stdClass();
$record->courseid = $courseid;
$record->workflowid = $workflowid;
$record->timestepchanged = time();
$process = process::from_record($record);
$process->id = $DB->insert_record('tool_cleanupcourses_process', $process);
return $process;
}
/**
* @return process[]
*/
public static function get_processes() {
global $DB;
$records = $DB->get_records('tool_cleanupcourses_process');
$processes = array();
foreach ($records as $record) {
}
return $processes;
}
/**
* Creates a process for the course which is at the respective step the trigger is followed by.
* @param int $processid id of the process
* @return process
*/
public static function get_process_by_id($processid) {
global $DB;
$record = $DB->get_record('tool_cleanupcourses_process', array('id' => $processid));
if ($record) {
return process::from_record($record);
} else {
return null;
}
/**
* Proceeds the process to the next step.
* @param process $process
* @return true, if followedby another step; otherwise false.
*/
public static function proceed_process(&$process) {
global $DB;
$step = step_manager::get_step_instance_by_workflow_index($process->workflowid, $process->stepindex + 1);
if ($step) {
$process->stepindex++;
$process->waiting = false;
$process->timestepchanged = time();
$DB->update_record('tool_cleanupcourses_process', $process);
} else {
try {
if (get_course($process->courseid)) {
debugging('Course should no longer exist!!!!');
}
} catch (\dml_missing_record_exception $e) {
// Expected behaviour!
debugging('Course deleted properly.');
self::remove_process($process);
}
}
/**
* Sets the process status on waiting.
* @param process $process
*/
public static function set_process_waiting(&$process) {
global $DB;
$process->waiting = true;
$DB->update_record('tool_cleanupcourses_process', $process);
}
/**
* Currently only removes the current process.
* @param process $process process the rollback should be triggered for.
*/
public static function rollback_process($process) {
// TODO: Add logic to revert changes made by steps.
delayed_courses_manager::set_course_delayed($process->courseid, $CFG->cleanupcourses_duration);
self::remove_process($process);
}
/**
* Removes the process and all data connected to it.
* @param process $process process to be deleted.
*/
private static function remove_process($process) {
global $DB;
$DB->delete_records('tool_cleanupcourses_procdata', array('processid' => $process->id));
$DB->delete_records('tool_cleanupcourses_process', (array) $process);
}