Proyectos de Subversion Moodle

<?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/>.

/**
 * unilabel module.
 *
 * @package     mod_unilabel
 * @author      Andreas Grabs <info@grabs-edv.de>
 * @copyright   2018 onwards Grabs EDV {@link https://www.grabs-edv.de}
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
defined('MOODLE_INTERNAL') || die;

require_once($CFG->dirroot . '/mod/unilabel/backup/moodle2/restore_unilabel_stepslib.php'); // Because it exists (must).

/**
 * Unilabel restore task class.
 *
 * This class provides all the settings and steps to perform one complete restore of the activity
 * @package     mod_unilabel
 * @author      Andreas Grabs <info@grabs-edv.de>
 * @copyright   2018 onwards Grabs EDV {@link https://www.grabs-edv.de}
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class restore_unilabel_activity_task extends restore_activity_task {
    /**
     * Define (add) particular settings this activity can have.
     */
    protected function define_my_settings() {
        // No particular settings for this activity.
    }

    /**
     * Define (add) particular steps this activity can have.
     */
    protected function define_my_steps() {
        // Unilabel only has one structure step.
        $this->add_step(new restore_unilabel_activity_structure_step('unilabel_structure', 'unilabel.xml'));
    }

    /**
     * Define the contents in the activity that must be
     * processed by the link decoder.
     */
    public static function define_decode_contents() {
        $contents = [];

        $contents[] = new restore_decode_content('unilabel', ['intro'], 'unilabel');

        // Go through all subplugins and add their settings pages.
        $plugins = \core_component::get_plugin_list_with_file('unilabeltype', 'settings.php', false);
        foreach ($plugins as $plugin => $settingspath) {
            $restorescript = dirname($settingspath) . '/backup/moodle2/restore_unilabeltype_' . $plugin . '_subplugin.class.php';
            if (is_file($restorescript)) {
                require_once($restorescript);
            }
            $classname = 'restore_unilabeltype_' . $plugin . '_subplugin';
            if (method_exists($classname, 'define_decode_contents')) {
                $contents = array_merge($contents, $classname::define_decode_contents());
            }
        }

        return $contents;
    }

    /**
     * Define the decoding rules for links belonging
     * to the activity to be executed by the link decoder.
     */
    public static function define_decode_rules() {
        return [];
    }

    /**
     * Define the restore log rules that will be applied
     * by the {@see restore_logs_processor} when restoring
     * unilabel logs. It must return one array
     * of {@see restore_log_rule} objects.
     */
    public static function define_restore_log_rules() {
        $rules = [];

        $rules[] = new restore_log_rule('unilabel', 'add', 'view.php?id={course_module}', '{unilabel}');
        $rules[] = new restore_log_rule('unilabel', 'update', 'view.php?id={course_module}', '{unilabel}');
        $rules[] = new restore_log_rule('unilabel', 'view', 'view.php?id={course_module}', '{unilabel}');

        return $rules;
    }

    /**
     * Define the restore log rules that will be applied
     * by the {@see restore_logs_processor} when restoring
     * course logs. It must return one array
     * of {@see restore_log_rule} objects.
     *
     * Note this rules are applied when restoring course logs
     * by the restore final task, but are defined here at
     * activity level. All them are rules not linked to any module instance (cmid = 0)
     */
    public static function define_restore_log_rules_for_course() {
        $rules = [];

        $rules[] = new restore_log_rule('unilabel', 'view all', 'index.php?id={course}', null);

        return $rules;
    }

    /**
     * After restore is done, rebuild the course cache.
     *
     * @return void
     */
    public function after_restore() {
        $course = get_course($this->get_courseid());
        \course_modinfo::build_course_cache($course);
    }
}