Your IP : 192.168.165.1
<?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/>.
/**
* Abstract class for common properties of scheduled_task and adhoc_task.
*
* @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 for common properties of scheduled_task and adhoc_task.
*
* @copyright 2013 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class task_base {
/** @var \core\lock\lock $lock - The lock controlling this task. */
private $lock = null;
/** @var \core\lock\lock $cronlock - The lock controlling the entire cron process. */
private $cronlock = null;
/** @var $string $component - The component this task belongs to. */
private $component = '';
/** @var bool $blocking - Does this task block the entire cron process. */
private $blocking = false;
/** @var int $faildelay - Exponentially increasing fail delay */
private $faildelay = 0;
/** @var int $nextruntime - When this task is due to run next */
private $nextruntime = 0;
/**
* Set the current lock for this task.
* @param \core\lock\lock $lock
*/
public function set_lock(\core\lock\lock $lock) {
$this->lock = $lock;
}
/**
* Set the current lock for the entire cron process.
* @param \core\lock\lock $lock
*/
public function set_cron_lock(\core\lock\lock $lock) {
$this->cronlock = $lock;
}
/**
* Get the current lock for this task.
* @return \core\lock\lock
*/
public function get_lock() {
return $this->lock;
}
/**
* Get the next run time for this task.
* @return int timestamp
*/
public function get_next_run_time() {
return $this->nextruntime;
}
/**
* Set the next run time for this task.
* @param int $nextruntime
*/
public function set_next_run_time($nextruntime) {
$this->nextruntime = $nextruntime;
}
/**
* Get the current lock for the entire cron.
* @return \core\lock\lock
*/
public function get_cron_lock() {
return $this->cronlock;
}
/**
* Setter for $blocking.
* @param bool $blocking
*/
public function set_blocking($blocking) {
$this->blocking = $blocking;
}
/**
* Getter for $blocking.
* @return bool
*/
public function is_blocking() {
return $this->blocking;
}
/**
* Setter for $component.
* @param string $component
*/
public function set_component($component) {
$this->component = $component;
}
/**
* Getter for $component.
* @return string
*/
public function get_component() {
return $this->component;
}
/**
* Setter for $faildelay.
* @param int $faildelay
*/
public function set_fail_delay($faildelay) {
$this->faildelay = $faildelay;
}
/**
* Getter for $faildelay.
* @return int
*/
public function get_fail_delay() {
return $this->faildelay;
}
/**
* Do the job.
* Throw exceptions on errors (the job will be retried).
*/
public abstract function execute();
}