backup MDL-22254 Added backup and restore of course completion information
[moodle.git] / backup / moodle2 / restore_final_task.class.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  * Final task that provides all the final steps necessary in order to finish one
27  * restore like gradebook, interlinks... apart from some final cleaning
28  *
29  * TODO: Finish phpdocs
30  */
31 class restore_final_task extends restore_task {
33     /**
34      * Create all the steps that will be part of this task
35      */
36     public function build() {
38         // Review all the block_position records in backup_ids in order
39         // match them now that all the contexts are created populating DB
40         // as needed. Only if we are restoring blocks.
41         if ($this->get_setting_value('blocks')) {
42             $this->add_step(new restore_review_pending_block_positions('review_block_positions'));
43         }
45         // Gradebook. Don't restore the gradebook unless activities are being restored.
46         if ($this->get_setting_value('activities')) {
47             $this->add_step(new restore_gradebook_structure_step('gradebook_step','gradebook.xml'));
48         }
50         // Course completion
51         $this->add_step(new restore_course_completion_structure_step('course_completion', 'completion.xml'));
53         // Review all the module_availability records in backup_ids in order
54         // to match them with existing modules / grade items.
55         $this->add_step(new restore_process_course_modules_availability('process_modules_availability'));
57         // Decode all the interlinks
58         $this->add_step(new restore_decode_interlinks('decode_interlinks'));
60         // Rebuild course cache to see results, whoah!
61         $this->add_step(new restore_rebuild_course_cache('rebuild_course_cache'));
63         // Clean the temp dir (conditionally) and drop temp table
64         $this->add_step(new restore_drop_and_clean_temp_stuff('drop_and_clean_temp_stuff'));
66         $this->built = true;
67     }
69 // Protected API starts here
71     /**
72      * Define the common setting that any restore type will have
73      */
74     protected function define_settings() {
75         // This task has not settings (could have them, like destination or so in the future, let's see)
76     }
77 }