MDL-23752 backup - export/import mode. Fixed various details.
[moodle.git] / backup / util / plan / backup_plan.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  * Implementable class defining the needed stuf for one backup plan
27  *
28  * TODO: Finish phpdocs
29  */
30 class backup_plan extends base_plan implements loggable {
32     protected $controller; // The backup controller building/executing this plan
33     protected $basepath;   // Fullpath to dir where backup is created
34     protected $excludingdactivities;
36     /**
37      * Constructor - instantiates one object of this class
38      */
39     public function __construct($controller) {
40         global $CFG;
42         if (! $controller instanceof backup_controller) {
43             throw new backup_plan_exception('wrong_backup_controller_specified');
44         }
45         $this->controller = $controller;
46         $this->basepath   = $CFG->dataroot . '/temp/backup/' . $controller->get_backupid();
47         parent::__construct('backup_plan');
48     }
50     public function build() {
51         backup_factory::build_plan($this->controller); // Dispatch to correct format
52         $this->built = true;
53     }
55     public function get_backupid() {
56         return $this->controller->get_backupid();
57     }
59     public function get_mode() {
60         return $this->controller->get_mode();
61     }
63     public function get_courseid() {
64         return $this->controller->get_courseid();
65     }
67     public function get_basepath() {
68         return $this->basepath;
69     }
71     public function get_logger() {
72         return $this->controller->get_logger();
73     }
75     public function is_excluding_activities() {
76         return $this->excludingdactivities;
77     }
79     public function set_excluding_activities() {
80         $this->excludingdactivities = true;
81     }
83     public function log($message, $level, $a = null, $depth = null, $display = false) {
84         backup_helper::log($message, $level, $a, $depth, $display, $this->get_logger());
85     }
87     /**
88      * Function responsible for executing the tasks of any plan
89      */
90     public function execute() {
91         if ($this->controller->get_status() != backup::STATUS_AWAITING) {
92             throw new backup_controller_exception('backup_not_executable_awaiting_required', $this->controller->get_status());
93         }
94         $this->controller->set_status(backup::STATUS_EXECUTING);
95         parent::execute();
96         $this->controller->set_status(backup::STATUS_FINISHED_OK);
97     }
98 }
100 /*
101  * Exception class used by all the @backup_plan stuff
102  */
103 class backup_plan_exception extends base_plan_exception {
105     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
106         parent::__construct($errorcode, $a, $debuginfo);
107     }