NOBUG: Added support for after_restore() methods on restore. Will help some blocks.
[moodle.git] / backup / moodle2 / restore_final_task.class.php
CommitLineData
864842aa
EL
1<?php
2
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/>.
17
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 */
24
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 */
31class restore_final_task extends restore_task {
32
33 /**
34 * Create all the steps that will be part of this task
35 */
36 public function build() {
37
41941110
EL
38 // Move all the CONTEXT_MODULE question qcats to their
39 // final (newly created) module context
40 $this->add_step(new restore_move_module_questions_categories('move_module_question_categories'));
41
42 // Create all the question files now that every question is in place
43 // and every category has its final contextid associated
44 $this->add_step(new restore_create_question_files('create_question_files'));
45
b8e455a7
EL
46 // Review all the block_position records in backup_ids in order
47 // match them now that all the contexts are created populating DB
48 // as needed. Only if we are restoring blocks.
49 if ($this->get_setting_value('blocks')) {
50 $this->add_step(new restore_review_pending_block_positions('review_block_positions'));
51 }
52
9a20df96
AD
53 // Gradebook. Don't restore the gradebook unless activities are being restored.
54 if ($this->get_setting_value('activities')) {
55 $this->add_step(new restore_gradebook_structure_step('gradebook_step','gradebook.xml'));
56 }
5ab8d2de 57
bd39b6f2
SH
58 // Course completion
59 $this->add_step(new restore_course_completion_structure_step('course_completion', 'completion.xml'));
60
5095f325
EL
61 // Review all the module_availability records in backup_ids in order
62 // to match them with existing modules / grade items.
63 $this->add_step(new restore_process_course_modules_availability('process_modules_availability'));
64
5ab8d2de
EL
65 // Decode all the interlinks
66 $this->add_step(new restore_decode_interlinks('decode_interlinks'));
67
68 // Rebuild course cache to see results, whoah!
69 $this->add_step(new restore_rebuild_course_cache('rebuild_course_cache'));
395dae30 70
648a575e
EL
71 // Review all the executed tasks having one after_restore method
72 // executing it to perform some final adjustments of information
73 // not available when the task was executed.
74 // This step is always the last one before the one cleaning the temp stuff!
75 $this->add_step(new restore_execute_after_restore('executing_after_restore'));
76
482aac65
EL
77 // Clean the temp dir (conditionally) and drop temp table
78 $this->add_step(new restore_drop_and_clean_temp_stuff('drop_and_clean_temp_stuff'));
79
864842aa
EL
80 $this->built = true;
81 }
82
648a575e
EL
83 /**
84 * Special method, only available in the restore_final_task, able to invoke the
85 * restore_plan execute_after_restore() method, so restore_execute_after_restore step
86 * will be able to launch all the after_restore() methods of the executed tasks
87 */
88 public function launch_execute_after_restore() {
89 $this->plan->execute_after_restore();
90 }
91
864842aa
EL
92// Protected API starts here
93
94 /**
95 * Define the common setting that any restore type will have
96 */
97 protected function define_settings() {
98 // This task has not settings (could have them, like destination or so in the future, let's see)
99 }
100}