a7bb672d8b5a50c3a2c66a725d876d3f60ecdc1e
[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
22  * @subpackage folder
23  * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Define the complete folder structure for backup, with file and id annotations
31  */
32 class backup_folder_activity_structure_step extends backup_activity_structure_step {
34     protected function define_structure() {
36         // To know if we are including userinfo
37         $userinfo = $this->get_setting_value('userinfo');
39         // Define each element separated
40         $folder = new backup_nested_element('folder', array('id'), array(
41             'name', 'intro', 'introformat', 'revision',
42             'timemodified', 'display'));
44         // Build the tree
45         // (nice mono-tree, lol)
47         // Define sources
48         $folder->set_source_table('folder', array('id' => backup::VAR_ACTIVITYID));
50         // Define id annotations
51         // (none)
53         // Define file annotations
54         $folder->annotate_files('mod_folder', 'intro', null);
55         $folder->annotate_files('mod_folder', 'content', null);
57         // Return the root element (folder), wrapped into standard activity structure
58         return $this->prepare_activity_structure($folder);
59     }
60 }