3 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * Defines classes used to handle backup settings
21 * @package core_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
28 // TODO: Reduce these to the minimum because ui/dependencies are 100% separated
30 // Root backup settings
33 * root generic setting to store different things without dependencies
35 class backup_generic_setting
extends root_backup_setting
{}
38 * root setting to handle backup file names (no dependencies nor anything else)
40 class backup_filename_setting
extends backup_generic_setting
{
43 * Instantiates a setting object
45 * @param string $name Name of the setting
46 * @param string $vtype Type of the setting, eg {@link base_setting::IS_TEXT}
47 * @param mixed $value Value of the setting
48 * @param bool $visibility Is the setting visible in the UI, eg {@link base_setting::VISIBLE}
49 * @param int $status Status of the setting with regards to the locking, eg {@link base_setting::NOT_LOCKED}
51 public function __construct($name, $vtype, $value = null, $visibility = self
::VISIBLE
, $status = self
::NOT_LOCKED
) {
52 parent
::__construct($name, $vtype, $value, $visibility, $status);
55 public function set_ui_filename($label, $value, array $options = null) {
56 $this->make_ui(self
::UI_HTML_TEXTFIELD
, $label, null, $options);
57 $this->set_value($value);
62 * root setting to control if backup will include user information
63 * A lot of other settings are dependent of this (module's user info,
64 * grades user info, messages, blogs...
66 class backup_users_setting
extends backup_generic_setting
{}
69 * root setting to control if backup will include activities or no.
70 * A lot of other settings (_included at activity levels)
71 * are dependent of this setting
73 class backup_activities_setting
extends backup_generic_setting
{}
76 * root setting to control if backup will generate anonymized
77 * user info or no, depends of @backup_users_setting so only is
78 * available if the former is enabled (apart from security
81 class backup_anonymize_setting
extends root_backup_setting
{}
84 * root setting to control if backup will include
85 * role assignments or no (any level), depends of @backup_users_setting
86 * exactly in the same way than @backup_anonymize_setting so we extend from it
88 class backup_role_assignments_setting
extends backup_anonymize_setting
{}
91 * root setting to control if backup will include
92 * logs or no (any level), depends of @backup_users_setting
93 * exactly in the same way than @backup_anonymize_setting so we extend from it
95 class backup_logs_setting
extends backup_anonymize_setting
{}
98 * root setting to control if backup will include
99 * comments or no (any level), depends of @backup_users_setting
100 * exactly in the same way than @backup_anonymize_setting so we extend from it
102 class backup_comments_setting
extends backup_anonymize_setting
{}
105 * root setting to control if backup will include badges or not,
106 * depends on @backup_activities_setting
108 class backup_badges_setting
extends backup_generic_setting
{}
111 * root setting to control if backup will include
112 * calender events or no (any level), depends of @backup_users_setting
113 * exactly in the same way than @backup_anonymize_setting so we extend from it
115 class backup_calendarevents_setting
extends backup_anonymize_setting
{}
118 * root setting to control if backup will include
119 * users completion data or no (any level), depends of @backup_users_setting
120 * exactly in the same way than @backup_anonymize_setting so we extend from it
122 class backup_userscompletion_setting
extends backup_anonymize_setting
{}
124 // Section backup settings
127 * generic section setting to pass various settings between tasks and steps
129 class backup_section_generic_setting
extends section_backup_setting
{}
132 * Setting to define if one section is included or no. Activities _included
133 * settings depend of them if available
135 class backup_section_included_setting
extends section_backup_setting
{}
138 * section backup setting to control if section will include
139 * user information or no, depends of @backup_users_setting
141 class backup_section_userinfo_setting
extends section_backup_setting
{}
144 // Activity backup settings
147 * generic activity setting to pass various settings between tasks and steps
149 class backup_activity_generic_setting
extends activity_backup_setting
{}
152 * activity backup setting to control if activity will
153 * be included or no, depends of @backup_activities_setting and
154 * optionally parent section included setting
156 class backup_activity_included_setting
extends activity_backup_setting
{}
159 * activity backup setting to control if activity will include
160 * user information or no, depends of @backup_users_setting
162 class backup_activity_userinfo_setting
extends activity_backup_setting
{}