MDL-22138 backup - I know smaller cathedrals than this, yay quizzes!
[moodle.git] / mod / forum / backup / moodle2 / backup_forum_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  * @package moodlecore
20  * @subpackage backup-moodle2
21  * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * Define all the backup steps that will be used by the backup_forum_activity_task
27  */
29 /**
30  * Define the complete forum structure for backup, with file and id annotations
31  */
32 class backup_forum_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
41         $forum = new backup_nested_element('forum', array('id'), array(
42             'type', 'name', 'intro', 'introformat',
43             'assessed', 'assesstimestart', 'assesstimefinish', 'scale',
44             'maxbytes', 'maxattachments', 'forcesubscribe', 'trackingtype',
45             'rsstype', 'rssarticles', 'timemodified', 'warnafter',
46             'blockafter', 'blockperiod', 'completiondiscussions', 'completionreplies',
47             'completionposts'));
49         $discussions = new backup_nested_element('discussions');
51         $discussion = new backup_nested_element('discussion', array('id'), array(
52             'name', 'firstpost', 'userid', 'groupid',
53             'assessed', 'timemodified', 'usermodified', 'timestart',
54             'timeend'));
56         $posts = new backup_nested_element('posts');
58         $post = new backup_nested_element('post', array('id'), array(
59             'parent', 'userid', 'created', 'modified',
60             'mailed', 'subject', 'message', 'messageformat',
61             'messagetrust', 'attachment', 'totalscore', 'mailnow'));
63         $ratings = new backup_nested_element('ratings');
65         $rating = new backup_nested_element('rating', array('id'), array(
66             'scaleid', 'value', 'userid', 'timecreated', 'timemodified'));
68         $subscriptions = new backup_nested_element('subscriptions');
70         $subscription = new backup_nested_element('subscription', array('id'), array(
71             'userid'));
73         $readposts = new backup_nested_element('readposts');
75         $read = new backup_nested_element('read', array('id'), array(
76             'userid', 'discussionid', 'postid', 'firstread',
77             'lastread'));
79         $trackedprefs = new backup_nested_element('trackedprefs');
81         $track = new backup_nested_element('track', array('id'), array(
82             'userid'));
84         // Build the tree
86         $forum->add_child($discussions);
87         $discussions->add_child($discussion);
89         $forum->add_child($subscriptions);
90         $subscriptions->add_child($subscription);
92         $forum->add_child($readposts);
93         $readposts->add_child($read);
95         $forum->add_child($trackedprefs);
96         $trackedprefs->add_child($track);
98         $discussion->add_child($posts);
99         $posts->add_child($post);
101         $post->add_child($ratings);
102         $ratings->add_child($rating);
104         // Define sources
106         $forum->set_source_table('forum', array('id' => backup::VAR_ACTIVITYID));
108         // All these source definitions only happen if we are including user info
109         if ($userinfo) {
110             $discussion->set_source_sql('
111                 SELECT *
112                   FROM {forum_discussions}
113                  WHERE forum = ?',
114                 array(backup::VAR_PARENTID));
116             // Need posts ordered by id so parents are always before childs on restore
117             $post->set_source_sql("SELECT *
118                                      FROM {forum_posts}
119                                     WHERE discussion = :discussion
120                                  ORDER BY id", array('discussion' => backup::VAR_PARENTID));
122             $subscription->set_source_table('forum_subscriptions', array('forum' => backup::VAR_PARENTID));
124             $read->set_source_table('forum_read', array('forumid' => backup::VAR_PARENTID));
126             $track->set_source_table('forum_track_prefs', array('forumid' => backup::VAR_PARENTID));
128             $rating->set_source_table('rating', array('contextid' => backup::VAR_CONTEXTID,
129                                                       'itemid'    => backup::VAR_PARENTID));
130             $rating->set_source_alias('rating', 'value');
131         }
133         // Define id annotations
135         $forum->annotate_ids('scale', 'scale');
137         $discussion->annotate_ids('group', 'groupid');
139         $post->annotate_ids('user', 'userid');
141         $rating->annotate_ids('scale', 'scaleid');
143         $rating->annotate_ids('user', 'userid');
145         $subscription->annotate_ids('user', 'userid');
147         $read->annotate_ids('user', 'userid');
149         $track->annotate_ids('user', 'userid');
151         // Define file annotations
153         $forum->annotate_files('mod_forum', 'intro', null); // This file area hasn't itemid
155         $post->annotate_files('mod_forum', 'post', 'id');
156         $post->annotate_files('mod_forum', 'attachment', 'id');
158         // Return the root element (forum), wrapped into standard activity structure
159         return $this->prepare_activity_structure($forum);
160     }