MDL-21432 backup - all sort of restore tasks
[moodle.git] / backup / moodle2 / restore_settingslib.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 // TODO: Reduce these to the minimum because ui/dependencies are 100% separated
27 // Root restore settings
29 /**
30  * root generic setting to store different things without dependencies
31  */
32 class restore_generic_setting extends root_backup_setting {}
34 /**
35  * root setting to control if restore will create user information
36  * A lot of other settings are dependent of this (module's user info,
37  * grades user info, messages, blogs...
38  */
39 class restore_users_setting extends restore_generic_setting {}
41 /**
42  * root setting to control if restore will create role assignments
43  * or no (any level), depends of @restore_users_setting
44  */
45 class restore_role_assignments_setting extends root_backup_setting {}
47 /**
48  * root setting to control if restore will create
49  * user files or no (images, local storage), depends of @restore_users_setting
50  * exactly in the same way than @restore_role_assignments_setting so we extend from it
51  */
52 class restore_user_files_setting extends restore_role_assignments_setting {}
54 /**
55  * root setting to control if restore will create activities
56  * A lot of other settings (_included at activity levels)
57  * are dependent of this setting
58  */
59 class restore_activities_setting extends restore_generic_setting {}
61 /**
62  * root setting to control if restore will create
63  * comments or no, depends of @restore_users_setting
64  * exactly in the same way than @restore_role_assignments_setting so we extend from it
65  */
66 class restore_comments_setting extends restore_role_assignments_setting {}
68 /**
69  * root setting to control if restore will create
70  * completion info or no, depends of @restore_users_setting
71  * exactly in the same way than @restore_role_assignments_setting so we extend from it
72  */
73 class restore_userscompletion_setting extends restore_role_assignments_setting {}
75 /**
76  * root setting to control if restore will create
77  * logs or no, depends of @restore_users_setting
78  * exactly in the same way than @restore_role_assignments_setting so we extend from it
79  */
80 class restore_logs_setting extends restore_role_assignments_setting {}
82 /**
83  * root setting to control if restore will create
84  * grade_histories or no, depends of @restore_users_setting
85  * exactly in the same way than @restore_role_assignments_setting so we extend from it
86  */
87 class restore_grade_histories_setting extends restore_role_assignments_setting {}
90 // Course restore settings
92 /**
93  * generic course setting to pass various settings between tasks and steps
94  */
95 class restore_course_generic_setting extends course_backup_setting {}
97 /**
98  * Setting to define is we are going to overwrite course configuration
99  */
100 class restore_course_overwrite_conf_setting extends restore_course_generic_setting {}
103 // Section restore settings
105 /**
106  * generic section setting to pass various settings between tasks and steps
107  */
108 class restore_section_generic_setting extends section_backup_setting {}
110 /**
111  * Setting to define if one section is included or no. Activities _included
112  * settings depend of them if available
113  */
114 class restore_section_included_setting extends restore_section_generic_setting {}
116 /**
117  * section backup setting to control if section will include
118  * user information or no, depends of @restore_users_setting
119  */
120 class restore_section_userinfo_setting extends restore_section_generic_setting {}
123 // Activity backup settings
125 /**
126  * generic activity setting to pass various settings between tasks and steps
127  */
128 class restore_activity_generic_setting extends activity_backup_setting {}
130 /**
131  * activity backup setting to control if activity will
132  * be included or no, depends of @restore_activities_setting and
133  * optionally parent section included setting
134  */
135 class restore_activity_included_setting extends restore_activity_generic_setting {}
137 /**
138  * activity backup setting to control if activity will include
139  * user information or no, depends of @restore_users_setting
140  */
141 class restore_activity_userinfo_setting extends restore_activity_generic_setting {}