adhoc_task.php 2.92 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<?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;

43
44
45
    /** @var integer|null $userid - Adhoc tasks may choose to run as a specific user. */
    private $userid = null;

46
47
48
49
50
51
52
53
54
    /**
     * Setter for $id.
     * @param int|null $id
     */
    public function set_id($id) {
        $this->id = $id;
    }

    /**
55
56
     * Getter for $userid.
     * @return int|null $userid
57
     */
58
59
    public function get_userid() {
        return $this->userid;
60
61
62
63
    }

    /**
     * Setter for $customdata.
64
     * @param mixed $customdata (anything that can be handled by json_encode)
65
66
67
68
69
     */
    public function set_custom_data($customdata) {
        $this->customdata = json_encode($customdata);
    }

70
71
    /**
     * Alternate setter for $customdata. Expects the data as a json_encoded string.
72
     * @param string $customdata json_encoded string
73
74
75
76
77
     */
    public function set_custom_data_as_string($customdata) {
        $this->customdata = $customdata;
    }

78
79
    /**
     * Getter for $customdata.
80
     * @return mixed (anything that can be handled by json_decode).
81
82
83
84
85
     */
    public function get_custom_data() {
        return json_decode($this->customdata);
    }

86
87
    /**
     * Alternate getter for $customdata.
88
     * @return string this is the raw json encoded version.
89
90
91
92
93
     */
    public function get_custom_data_as_string() {
        return $this->customdata;
    }

94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
    /**
     * Getter for $id.
     * @return int|null $id
     */
    public function get_id() {
        return $this->id;
    }

    /**
     * Setter for $userid.
     * @param int|null $userid
     */
    public function set_userid($userid) {
        $this->userid = $userid;
    }
109

110
}