mirror of
https://github.com/moodle/moodle.git
synced 2025-07-21 06:11:21 +02:00
309ae8921f
Centralise management of all types of cron tasks with registration, scheduling, parallel task conflicts(blocking) and running once off tasks, all using an administration screen. This is a combination of several issues: MDL-25502: Added "black magic" task allocator for cron MDL-25503: Add step to cron to run all scheduled tasks MDL-25504 cron: Refactor to use scheduler MDL-25505: Add an admin interface to schedule tasks via cron. MDL-25507: Add support for adhoc tasks.
76 lines
2.1 KiB
PHP
76 lines
2.1 KiB
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/>.
|
|
|
|
/**
|
|
* Adhoc task abstract class.
|
|
*
|
|
* All background tasks should extend this class.
|
|
*
|
|
* @package core
|
|
* @category task
|
|
* @copyright 2013 Damyon Wiese
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core\task;
|
|
|
|
/**
|
|
* Abstract class defining an adhoc task.
|
|
* @copyright 2013 Damyon Wiese
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
abstract class adhoc_task extends task_base {
|
|
|
|
/** @var string $customdata - Custom data required for when this task is executed. */
|
|
private $customdata = '';
|
|
|
|
/** @var integer|null $id - Adhoc tasks each have their own database record id. */
|
|
private $id = null;
|
|
|
|
/**
|
|
* Setter for $id.
|
|
* @param int|null $id
|
|
*/
|
|
public function set_id($id) {
|
|
$this->id = $id;
|
|
}
|
|
|
|
/**
|
|
* Getter for $id.
|
|
* @return int|null $id
|
|
*/
|
|
public function get_id() {
|
|
return $this->id;
|
|
}
|
|
|
|
/**
|
|
* Setter for $customdata.
|
|
* @param object $customdata (anything that can be handled by json_encode)
|
|
*/
|
|
public function set_custom_data($customdata) {
|
|
$this->customdata = json_encode($customdata);
|
|
}
|
|
|
|
/**
|
|
* Getter for $customdata.
|
|
* @return object (anything that can be handled by json_decode).
|
|
*/
|
|
public function get_custom_data() {
|
|
return json_decode($this->customdata);
|
|
}
|
|
|
|
}
|