108b22219d4b6aa45b0e6cb6e5d4b6efa3ed6931
[moodle.git] / backup / util / plan / restore_task.class.php
1 <?php
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/>.
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  */
25 /**
26  * Abstract class defining the needed stuf for one restore task (a collection of steps)
27  *
28  * TODO: Finish phpdocs
29  */
30 abstract class restore_task extends base_task {
32     /**
33      * Constructor - instantiates one object of this class
34      */
35     public function __construct($name, $plan = null) {
36         if (!is_null($plan) && !($plan instanceof restore_plan)) {
37             throw new restore_task_exception('wrong_restore_plan_specified');
38         }
39         parent::__construct($name, $plan);
40     }
42     public function get_restoreid() {
43         return $this->plan->get_restoreid();
44     }
46     public function get_info() {
47         return $this->plan->get_info();
48     }
50     public function get_target() {
51         return $this->plan->get_target();
52     }
54     public function get_userid() {
55         return $this->plan->get_userid();
56     }
58     public function get_decoder() {
59         return $this->plan->get_decoder();
60     }
62     public function is_samesite() {
63         return $this->plan->is_samesite();
64     }
66     public function set_preloaded_information() {
67         $this->plan->set_preloaded_information();
68     }
70     public function get_preloaded_information() {
71         return $this->plan->get_preloaded_information();
72     }
74     public function get_tempdir() {
75         return $this->plan->get_tempdir();
76     }
78     public function get_old_contextid() {
79         return $this->plan->get_info()->original_course_contextid;
80     }
82     public function get_old_system_contextid() {
83         return $this->plan->get_info()->original_system_contextid;
84     }
85 }
87 /*
88  * Exception class used by all the @restore_task stuff
89  */
90 class restore_task_exception extends base_task_exception {
92     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
93         parent::__construct($errorcode, $a, $debuginfo);
94     }
95 }