You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
81 lines
3.0 KiB
81 lines
3.0 KiB
<?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/>.
|
|
|
|
/**
|
|
* Defines backup_theme_plugin class
|
|
*
|
|
* @package core_backup
|
|
* @subpackage moodle2
|
|
* @category backup
|
|
* @copyright 2011 onwards The Open University
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Base class for theme backup plugins.
|
|
*
|
|
* NOTE: When you back up a course, it runs backup for ALL themes - not just
|
|
* the currently selected one.
|
|
*
|
|
* That means that if, for example, a course was once in theme A, and theme A
|
|
* had some data settings, but it is then changed to theme B, the data settings
|
|
* will still be included in the backup and restore. With the restored course,
|
|
* if you ever change it back to theme A, the settings will be ready.
|
|
*
|
|
* It also means that other themes which are not the one set up for the course,
|
|
* but might be seen by some users (eg user themes, session themes, mnet themes)
|
|
* can store data.
|
|
*
|
|
* If this behaviour is not desired for a particular theme's data, the subclass
|
|
* can call is_current_theme('myname') to check.
|
|
*/
|
|
abstract class backup_theme_plugin extends backup_plugin {
|
|
|
|
/**
|
|
* @var string Current theme for course (may not be the same as plugin).
|
|
*/
|
|
protected $coursetheme;
|
|
|
|
/**
|
|
* @param string $plugintype Plugin type (always 'theme')
|
|
* @param string $pluginname Plugin name (name of theme)
|
|
* @param backup_optigroup $optigroup Group that will contain this data
|
|
* @param backup_course_structure_step $step Backup step that this is part of
|
|
*/
|
|
public function __construct($plugintype, $pluginname, $optigroup, $step) {
|
|
|
|
parent::__construct($plugintype, $pluginname, $optigroup, $step);
|
|
|
|
$this->coursetheme = backup_plan_dbops::get_theme_from_courseid(
|
|
$this->task->get_courseid());
|
|
|
|
}
|
|
|
|
/**
|
|
* Return condition for whether this theme should be backed up (= if it
|
|
* is the same theme as the one used in this course). This condition has
|
|
* the theme used in the course. It will be compared against the name
|
|
* of the theme, by use of third parameter in get_plugin_element; in
|
|
* subclass, you should do:
|
|
* $plugin = $this->get_plugin_element(null, $this->get_theme_condition(), 'mytheme');
|
|
*/
|
|
protected function get_theme_condition() {
|
|
return array('sqlparam' => $this->coursetheme);
|
|
}
|
|
}
|
|
|