4d559e048c992b995aa4c55f60366d047fc1e869
[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  * Defines classes used to handle restore settings
20  *
21  * @package     core_backup
22  * @subpackage  moodle2
23  * @category    backup
24  * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
25  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 // TODO: Reduce these to the minimum because ui/dependencies are 100% separated
32 // Root restore settings
34 /**
35  * root generic setting to store different things without dependencies
36  */
37 class restore_generic_setting extends root_backup_setting {}
39 /**
40  * root setting to control if restore will create user information
41  * A lot of other settings are dependent of this (module's user info,
42  * grades user info, messages, blogs...
43  */
44 class restore_users_setting extends restore_generic_setting {}
46 /**
47  * root setting to control if restore will create groups/grouping information. Depends on @restore_users_setting
48  *
49  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
50  * @copyright 2014 Matt Sammarco
51  */
52 class restore_groups_setting extends restore_generic_setting {
53 }
55 /**
56  * root setting to control if restore will create role assignments
57  * or no (any level), depends of @restore_users_setting
58  */
59 class restore_role_assignments_setting extends root_backup_setting {}
61 /**
62  * root setting to control if restore will create activities
63  * A lot of other settings (_included at activity levels)
64  * are dependent of this setting
65  */
66 class restore_activities_setting extends restore_generic_setting {}
68 /**
69  * root setting to control if restore will create
70  * comments 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_comments_setting extends restore_role_assignments_setting {}
75 /**
76  * root setting to control if restore will create badges or not,
77  * depends on @restore_activities_setting
78  */
79 class restore_badges_setting extends restore_generic_setting {}
81 /**
82  * root setting to control if competencies will also be restored.
83  */
84 class restore_competencies_setting extends restore_generic_setting {
86     /**
87      * restore_competencies_setting constructor.
88      * @param bool $hascompetencies Flag whether to set the restore setting as checked and unlocked.
89      */
90     public function __construct($hascompetencies) {
91         $defaultvalue = false;
92         $visibility = base_setting::HIDDEN;
93         $status = base_setting::LOCKED_BY_CONFIG;
94         if (\core_competency\api::is_enabled()) {
95             $visibility = base_setting::VISIBLE;
96             if ($hascompetencies) {
97                 $defaultvalue = true;
98                 $status = base_setting::NOT_LOCKED;
99             }
100         }
101         parent::__construct('competencies', base_setting::IS_BOOLEAN, $defaultvalue, $visibility, $status);
102     }
105 /**
106  * root setting to control if restore will create
107  * events or no, depends of @restore_users_setting
108  * exactly in the same way than @restore_role_assignments_setting so we extend from it
109  */
110 class restore_calendarevents_setting extends restore_role_assignments_setting {}
112 /**
113  * root setting to control if restore will create
114  * completion info or no, depends of @restore_users_setting
115  * exactly in the same way than @restore_role_assignments_setting so we extend from it
116  */
117 class restore_userscompletion_setting extends restore_role_assignments_setting {}
119 /**
120  * root setting to control if restore will create
121  * logs or no, depends of @restore_users_setting
122  * exactly in the same way than @restore_role_assignments_setting so we extend from it
123  */
124 class restore_logs_setting extends restore_role_assignments_setting {}
126 /**
127  * root setting to control if restore will create
128  * grade_histories or no, depends of @restore_users_setting
129  * exactly in the same way than @restore_role_assignments_setting so we extend from it
130  */
131 class restore_grade_histories_setting extends restore_role_assignments_setting {}
134 // Course restore settings
136 /**
137  * generic course setting to pass various settings between tasks and steps
138  */
139 class restore_course_generic_setting extends course_backup_setting {}
141 /**
142  * Setting to define is we are going to overwrite course configuration
143  */
144 class restore_course_overwrite_conf_setting extends restore_course_generic_setting {}
146 /**
147  * Setting to switch between current and new course name/startdate
148  *
149  * @copyright   2017 Marina Glancy
150  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
151  */
152 class restore_course_defaultcustom_setting extends restore_course_generic_setting {
153     /**
154      * Validates that the value $value has type $vtype
155      * @param int $vtype
156      * @param mixed $value
157      * @return mixed
158      */
159     public function validate_value($vtype, $value) {
160         if ($value === false) {
161             // Value "false" means default and is allowed for this setting type even if it does not match $vtype.
162             return $value;
163         }
164         return parent::validate_value($vtype, $value);
165     }
167     /**
168      * Special method for this element only. When value is "false" returns the default value.
169      * @return mixed
170      */
171     public function get_normalized_value() {
172         $value = $this->get_value();
173         if ($value === false && $this->get_ui() instanceof backup_setting_ui_defaultcustom) {
174             $attributes = $this->get_ui()->get_attributes();
175             return $attributes['defaultvalue'];
176         }
177         return $value;
178     }
182 class restore_course_generic_text_setting extends restore_course_generic_setting {
184     public function __construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED) {
185         parent::__construct($name, $vtype, $value, $visibility, $status);
186         $this->set_ui(new backup_setting_ui_text($this, $name));
187     }
191 // Section restore settings
193 /**
194  * generic section setting to pass various settings between tasks and steps
195  */
196 class restore_section_generic_setting extends section_backup_setting {}
198 /**
199  * Setting to define if one section is included or no. Activities _included
200  * settings depend of them if available
201  */
202 class restore_section_included_setting extends restore_section_generic_setting {}
204 /**
205  * section backup setting to control if section will include
206  * user information or no, depends of @restore_users_setting
207  */
208 class restore_section_userinfo_setting extends restore_section_generic_setting {}
211 // Activity backup settings
213 /**
214  * generic activity setting to pass various settings between tasks and steps
215  */
216 class restore_activity_generic_setting extends activity_backup_setting {}
218 /**
219  * activity backup setting to control if activity will
220  * be included or no, depends of @restore_activities_setting and
221  * optionally parent section included setting
222  */
223 class restore_activity_included_setting extends restore_activity_generic_setting {}
225 /**
226  * activity backup setting to control if activity will include
227  * user information or no, depends of @restore_users_setting
228  */
229 class restore_activity_userinfo_setting extends restore_activity_generic_setting {}