cfc0193bf03d822d4a96b2248fb067f598693856
[moodle.git] / mod / lesson / backup / moodle2 / restore_lesson_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 restore steps that will be used by the restore_lesson_activity_task
27  */
29 /**
30  * Structure step to restore one lesson activity
31  */
32 class restore_lesson_activity_structure_step extends restore_activity_structure_step {
34     protected function define_structure() {
36         $paths = array();
37         $userinfo = $this->get_setting_value('userinfo');
39         $paths[] = new restore_path_element('lesson', '/activity/lesson');
40         $paths[] = new restore_path_element('lesson_page', '/activity/lesson/pages/page');
41         $paths[] = new restore_path_element('lesson_answer', '/activity/lesson/pages/page/answers/answer');
42         if ($userinfo) {
43             $paths[] = new restore_path_element('lesson_attempt', '/activity/lesson/pages/page/answers/answer/attempts/attempt');
44             $paths[] = new restore_path_element('lesson_grade', '/activity/lesson/grades/grade');
45             $paths[] = new restore_path_element('lesson_branch', '/activity/lesson/pages/page/branches/branch');
46             $paths[] = new restore_path_element('lesson_highscore', '/activity/lesson/highscores/highscore');
47             $paths[] = new restore_path_element('lesson_timer', '/activity/lesson/timers/timer');
48         }
50         // Return the paths wrapped into standard activity structure
51         return $this->prepare_activity_structure($paths);
52     }
54     protected function process_lesson($data) {
55         global $DB;
57         $data = (object)$data;
58         $oldid = $data->id;
59         $data->course = $this->get_courseid();
61         $data->available = $this->apply_date_offset($data->available);
62         $data->deadline = $this->apply_date_offset($data->deadline);
63         $data->timemodified = $this->apply_date_offset($data->timemodified);
65         // insert the lesson record
66         $newitemid = $DB->insert_record('lesson', $data);
67         // inmediately after inserting "activity" record, call this
68         $this->apply_activity_instance($newitemid);
69     }
71     protected function process_lesson_page($data) {
72         global $DB;
74         $data = (object)$data;
75         $oldid = $data->id;
76         $data->lessonid = $this->get_new_parentid('lesson');
77         $data->prevpageid = (empty($data->prevpageid)) ? 0 : $this->get_mappingid('lesson_page', $data->prevpageid);
78         $data->nextpageid = 0; //we don't know the id of the next page as it hasn't been created yet.
79         $data->timemodified = $this->apply_date_offset($data->timemodified);
80         $data->timecreated = $this->apply_date_offset($data->timecreated);
82         $newitemid = $DB->insert_record('lesson_pages', $data);
83         $this->set_mapping('lesson_page', $oldid, $newitemid);
85         //now update previous page with newid as the nextpageid
86         if (!empty($data->prevpageid)) {
87             $prevpage = $DB->get_record('lesson_pages', array('lessonid'=>$data->lessonid, 'id'=>$data->prevpageid));
88             if (!empty($prevpage)) {
89                 $prevpage->nextpageid = $newitemid;
90                 $DB->update_record('lesson_pages', $prevpage);
91             }
92         }
93     }
95     protected function process_lesson_answer($data) {
96         global $DB;
98         $data = (object)$data;
99         $oldid = $data->id;
100         $data->lessonid = $this->get_new_parentid('lesson');
101         $data->pageid = $this->get_new_parentid('lesson_page');
102         $data->answer = $data->answer_text;
103         $data->timemodified = $this->apply_date_offset($data->timemodified);
104         $data->timecreated = $this->apply_date_offset($data->timecreated);
106         $newitemid = $DB->insert_record('lesson_answers', $data);
107         $this->set_mapping('lesson_answer', $oldid, $newitemid);
108     }
110     protected function process_lesson_attempt($data) {
111         global $DB;
113         $data = (object)$data;
114         $oldid = $data->id;
115         $data->lessonid = $this->get_new_parentid('lesson');
116         $data->pageid = $this->get_new_parentid('lesson_page');
117         $data->answerid = $this->get_new_parentid('lesson_answer');
118         $data->userid = $this->get_mappingid('user', $data->userid);
120         $newitemid = $DB->insert_record('lesson_attempts', $data);
121     }
123     protected function process_lesson_grade($data) {
124         global $DB;
126         $data = (object)$data;
127         $oldid = $data->id;
128         $data->lessonid = $this->get_new_parentid('lesson');
129         $data->userid = $this->get_mappingid('user', $data->userid);
131         $newitemid = $DB->insert_record('lesson_grades', $data);
132         $this->set_mapping('lesson_grade', $oldid, $newitemid);
133     }
135     protected function process_lesson_branch($data) {
136         global $DB;
138         $data = (object)$data;
139         $oldid = $data->id;
140         $data->lessonid = $this->get_new_parentid('lesson');
141         $data->pageid = $this->get_new_parentid('lesson_page');
142         $data->userid = $this->get_mappingid('user', $data->userid);
144         $newitemid = $DB->insert_record('lesson_branch', $data);
145         $this->set_mapping('lesson_branch', $oldid, $newitemid);
146     }
148     protected function process_lesson_highscore($data) {
149         global $DB;
151         $data = (object)$data;
152         $oldid = $data->id;
153         $data->lessonid = $this->get_new_parentid('lesson');
154         $data->userid = $this->get_mappingid('user', $data->userid);
155         $data->gradeid = $this->get_mappingid('lesson_grade', $data->gradeid);
157         $newitemid = $DB->insert_record('lesson_high_scores', $data);
158     }
160     protected function process_lesson_timer($data) {
161         global $DB;
163         $data = (object)$data;
164         $oldid = $data->id;
165         $data->lessonid = $this->get_new_parentid('lesson');
166         $data->userid = $this->get_mappingid('user', $data->userid);
168         $newitemid = $DB->insert_record('lesson_timer', $data);
169     }
171     protected function after_execute() {
172         // Add lesson related files, no need to match by itemname (just internally handled context)
173         $this->add_related_files('mod_lesson', 'mediafile', 'id');
174         $this->add_related_files('mod_lesson', 'page_contents', 'id');
175     }