| 1 |
efrain |
1 |
<?php
|
|
|
2 |
|
|
|
3 |
// This file is part of Moodle - http://moodle.org/
|
|
|
4 |
//
|
|
|
5 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
6 |
// it under the terms of the GNU General Public License as published by
|
|
|
7 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
8 |
// (at your option) any later version.
|
|
|
9 |
//
|
|
|
10 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
11 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
12 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
13 |
// GNU General Public License for more details.
|
|
|
14 |
//
|
|
|
15 |
// You should have received a copy of the GNU General Public License
|
|
|
16 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
17 |
|
|
|
18 |
/**
|
|
|
19 |
* @package moodlecore
|
|
|
20 |
* @subpackage backup-plan
|
|
|
21 |
* @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
|
|
|
22 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
23 |
*/
|
|
|
24 |
|
|
|
25 |
/**
|
|
|
26 |
* Abstract class defining the needed stuf for one backup task (a collection of steps)
|
|
|
27 |
*
|
|
|
28 |
* TODO: Finish phpdocs
|
|
|
29 |
*/
|
|
|
30 |
abstract class backup_task extends base_task {
|
|
|
31 |
|
|
|
32 |
/**
|
|
|
33 |
* Constructor - instantiates one object of this class
|
|
|
34 |
*/
|
|
|
35 |
public function __construct($name, $plan = null) {
|
|
|
36 |
if (!is_null($plan) && !($plan instanceof backup_plan)) {
|
|
|
37 |
throw new backup_task_exception('wrong_backup_plan_specified');
|
|
|
38 |
}
|
|
|
39 |
parent::__construct($name, $plan);
|
|
|
40 |
}
|
|
|
41 |
|
|
|
42 |
public function get_backupid() {
|
|
|
43 |
return $this->plan->get_backupid();
|
|
|
44 |
}
|
|
|
45 |
|
|
|
46 |
public function is_excluding_activities() {
|
|
|
47 |
return $this->plan->is_excluding_activities();
|
|
|
48 |
}
|
|
|
49 |
|
|
|
50 |
/**
|
|
|
51 |
* Get the user roles that should be kept in the destination course
|
|
|
52 |
* for a course copy operation.
|
|
|
53 |
*
|
|
|
54 |
* @return array
|
|
|
55 |
*/
|
|
|
56 |
public function get_kept_roles(): array {
|
|
|
57 |
return $this->plan->get_kept_roles();
|
|
|
58 |
}
|
|
|
59 |
}
|
|
|
60 |
|
|
|
61 |
/*
|
|
|
62 |
* Exception class used by all the @backup_task stuff
|
|
|
63 |
*/
|
|
|
64 |
class backup_task_exception extends base_task_exception {
|
|
|
65 |
|
|
|
66 |
public function __construct($errorcode, $a=NULL, $debuginfo=null) {
|
|
|
67 |
parent::__construct($errorcode, $a, $debuginfo);
|
|
|
68 |
}
|
|
|
69 |
}
|