MDL-71200 mod_folder: ensure "Download folder" option is backed up.
[moodle.git] / mod / folder / backup / moodle2 / backup_folder_stepslib.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  * Define all the backup steps that will be used by the backup_folder_activity_task
20  *
21  * @package   mod_folder
22  * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * Define the complete folder structure for backup, with file and id annotations
30  */
31 class backup_folder_activity_structure_step extends backup_activity_structure_step {
33     protected function define_structure() {
35         // To know if we are including userinfo
36         $userinfo = $this->get_setting_value('userinfo');
38         // Define each element separated
39         $folder = new backup_nested_element('folder', array('id'), array(
40             'name', 'intro', 'introformat', 'revision',
41             'timemodified', 'display', 'showexpanded', 'showdownloadfolder', 'forcedownload'));
43         // Build the tree
44         // (nice mono-tree, lol)
46         // Define sources
47         $folder->set_source_table('folder', array('id' => backup::VAR_ACTIVITYID));
49         // Define id annotations
50         // (none)
52         // Define file annotations
53         $folder->annotate_files('mod_folder', 'intro', null);
54         $folder->annotate_files('mod_folder', 'content', null);
56         // Return the root element (folder), wrapped into standard activity structure
57         return $this->prepare_activity_structure($folder);
58     }
59 }