moodle/backup/controller/base_controller.class.php
sam marshall 77b3d9dfdf MDL-38196 Backup/restore: Display log if non-empty
When doing a backup or restore operation with the normal user interface,
if there is anything in the backup/restore log, it will now be displayed
at the end of the process below the Continue button.

If you have developer debugging enabled, it sets the display level to
LOG_DEBUG and there will always be content in the log. Otherwise, it
uses LOG_INFO which generally means the log is empty, and nothing
displays (no visible change for users).
2013-10-08 11:00:11 +01:00

85 lines
2.5 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/>.
/**
* Base class with shared stuff between backup controller and restore
* controller.
*
* @package core_backup
* @copyright 2013 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class base_controller extends backup implements loggable {
/**
* @var core_backup_progress Progress reporting object.
*/
protected $progress;
/**
* @var base_logger Logging chain object (moodle, inline, fs, db, syslog)
*/
protected $logger;
/**
* Gets the progress reporter, which can be used to report progress within
* the backup or restore process.
*
* @return core_backup_progress Progress reporting object
*/
public function get_progress() {
return $this->progress;
}
/**
* Sets the progress reporter.
*
* @param core_backup_progress $progress Progress reporting object
*/
public function set_progress(core_backup_progress $progress) {
$this->progress = $progress;
}
/**
* Gets first logger in logging chain.
*
* @return base_logger Logger
*/
public function get_logger() {
return $this->logger;
}
/**
* Inserts a new logger at end of logging chain.
*
* @param base_logger $logger New logger to add
*/
public function add_logger(base_logger $logger) {
$existing = $this->logger;
while ($existing->get_next()) {
$existing = $existing->get_next();
}
$existing->set_next($logger);
}
/**
* Logs data to the logger chain.
*
* @see loggable::log()
*/
public function log($message, $level, $a = null, $depth = null, $display = false) {
backup_helper::log($message, $level, $a, $depth, $display, $this->logger);
}
}