mirror of
https://github.com/moodle/moodle.git
synced 2025-02-08 09:02:07 +01:00
120 lines
3.7 KiB
PHP
120 lines
3.7 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* @package moodlecore
|
|
* @subpackage backup-plan
|
|
* @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
/**
|
|
* Implementable class defining the needed stuf for one backup plan
|
|
*
|
|
* TODO: Finish phpdocs
|
|
*/
|
|
class backup_plan extends base_plan implements loggable {
|
|
|
|
protected $controller; // The backup controller building/executing this plan
|
|
protected $basepath; // Fullpath to dir where backup is created
|
|
protected $excludingdactivities;
|
|
|
|
/**
|
|
* Constructor - instantiates one object of this class
|
|
*/
|
|
public function __construct($controller) {
|
|
global $CFG;
|
|
|
|
if (! $controller instanceof backup_controller) {
|
|
throw new backup_plan_exception('wrong_backup_controller_specified');
|
|
}
|
|
$this->controller = $controller;
|
|
$this->basepath = $CFG->tempdir . '/backup/' . $controller->get_backupid();
|
|
$this->excludingdactivities = false;
|
|
parent::__construct('backup_plan');
|
|
}
|
|
|
|
/**
|
|
* Destroy all circular references. It helps PHP 5.2 a lot!
|
|
*/
|
|
public function destroy() {
|
|
// No need to destroy anything recursively here, direct reset
|
|
$this->controller = null;
|
|
// Delegate to base plan the rest
|
|
parent::destroy();
|
|
}
|
|
|
|
public function build() {
|
|
backup_factory::build_plan($this->controller); // Dispatch to correct format
|
|
$this->built = true;
|
|
}
|
|
|
|
public function get_backupid() {
|
|
return $this->controller->get_backupid();
|
|
}
|
|
|
|
public function get_mode() {
|
|
return $this->controller->get_mode();
|
|
}
|
|
|
|
public function get_courseid() {
|
|
return $this->controller->get_courseid();
|
|
}
|
|
|
|
public function get_basepath() {
|
|
return $this->basepath;
|
|
}
|
|
|
|
public function get_logger() {
|
|
return $this->controller->get_logger();
|
|
}
|
|
|
|
public function is_excluding_activities() {
|
|
return $this->excludingdactivities;
|
|
}
|
|
|
|
public function set_excluding_activities() {
|
|
$this->excludingdactivities = true;
|
|
}
|
|
|
|
public function log($message, $level, $a = null, $depth = null, $display = false) {
|
|
backup_helper::log($message, $level, $a, $depth, $display, $this->get_logger());
|
|
}
|
|
|
|
/**
|
|
* Function responsible for executing the tasks of any plan
|
|
*/
|
|
public function execute() {
|
|
if ($this->controller->get_status() != backup::STATUS_AWAITING) {
|
|
throw new backup_controller_exception('backup_not_executable_awaiting_required', $this->controller->get_status());
|
|
}
|
|
$this->controller->set_status(backup::STATUS_EXECUTING);
|
|
parent::execute();
|
|
$this->controller->set_status(backup::STATUS_FINISHED_OK);
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Exception class used by all the @backup_plan stuff
|
|
*/
|
|
class backup_plan_exception extends base_plan_exception {
|
|
|
|
public function __construct($errorcode, $a=NULL, $debuginfo=null) {
|
|
parent::__construct($errorcode, $a, $debuginfo);
|
|
}
|
|
}
|