source: moodle/trunk/fuentes/backup/moodle2/backup_settingslib.php @ 1331

Last change on this file since 1331 was 1331, checked in by jrpelegrina, 3 years ago

Updated to moodle 3.0.3

File size: 5.9 KB
Line 
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 * Defines classes used to handle backup 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 */
27
28// TODO: Reduce these to the minimum because ui/dependencies are 100% separated
29
30// Root backup settings
31
32/**
33 * root generic setting to store different things without dependencies
34 */
35class backup_generic_setting extends root_backup_setting {}
36
37/**
38 * root setting to handle backup file names (no dependencies nor anything else)
39 */
40class backup_filename_setting extends backup_generic_setting {
41
42    /**
43     * Instantiates a setting object
44     *
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}
50     */
51    public function __construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED) {
52        parent::__construct($name, $vtype, $value, $visibility, $status);
53    }
54
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);
58    }
59}
60
61/**
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...
65 */
66class backup_users_setting extends backup_generic_setting {}
67
68/**
69 * root setting to control if backup will include group information depends on @backup_users_setting
70 *
71 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
72 * @copyright 2014 Matt Sammarco
73 */
74class backup_groups_setting extends backup_generic_setting {
75}
76
77/**
78 * root setting to control if backup will include activities or no.
79 * A lot of other settings (_included at activity levels)
80 * are dependent of this setting
81 */
82class backup_activities_setting extends backup_generic_setting {}
83
84/**
85 * root setting to control if backup will generate anonymized
86 * user info or no, depends of @backup_users_setting so only is
87 * available if the former is enabled (apart from security
88 * that can change it
89 */
90class backup_anonymize_setting extends root_backup_setting {}
91
92/**
93 * root setting to control if backup will include
94 * role assignments or no (any level), depends of @backup_users_setting
95 * exactly in the same way than @backup_anonymize_setting so we extend from it
96 */
97class backup_role_assignments_setting extends backup_anonymize_setting {}
98
99/**
100 * root setting to control if backup will include
101 * logs or no (any level), depends of @backup_users_setting
102 * exactly in the same way than @backup_anonymize_setting so we extend from it
103 */
104class backup_logs_setting extends backup_anonymize_setting {}
105
106/**
107 * root setting to control if backup will include
108 * comments or no (any level), depends of @backup_users_setting
109 * exactly in the same way than @backup_anonymize_setting so we extend from it
110 */
111class backup_comments_setting extends backup_anonymize_setting {}
112
113/**
114 * root setting to control if backup will include badges or not,
115 * depends on @backup_activities_setting
116 */
117class backup_badges_setting extends backup_generic_setting {}
118
119/**
120 * root setting to control if backup will include
121 * calender events or no (any level), depends of @backup_users_setting
122 * exactly in the same way than @backup_anonymize_setting so we extend from it
123 */
124class backup_calendarevents_setting extends backup_anonymize_setting {}
125
126/**
127 * root setting to control if backup will include
128 * users completion data or no (any level), depends of @backup_users_setting
129 * exactly in the same way than @backup_anonymize_setting so we extend from it
130 */
131class backup_userscompletion_setting extends backup_anonymize_setting {}
132
133// Section backup settings
134
135/**
136 * generic section setting to pass various settings between tasks and steps
137 */
138class backup_section_generic_setting extends section_backup_setting {}
139
140/**
141 * Setting to define if one section is included or no. Activities _included
142 * settings depend of them if available
143 */
144class backup_section_included_setting extends section_backup_setting {}
145
146/**
147 * section backup setting to control if section will include
148 * user information or no, depends of @backup_users_setting
149 */
150class backup_section_userinfo_setting extends section_backup_setting {}
151
152
153// Activity backup settings
154
155/**
156 * generic activity setting to pass various settings between tasks and steps
157 */
158class backup_activity_generic_setting extends activity_backup_setting {}
159
160/**
161 * activity backup setting to control if activity will
162 * be included or no, depends of @backup_activities_setting and
163 * optionally parent section included setting
164 */
165class backup_activity_included_setting extends activity_backup_setting {}
166
167/**
168 * activity backup setting to control if activity will include
169 * user information or no, depends of @backup_users_setting
170 */
171class backup_activity_userinfo_setting extends activity_backup_setting {}
Note: See TracBrowser for help on using the repository browser.