652d58064705bb961cce8da43caa388522109ee7
[moodle.git] / backup / util / ui / base_moodleform.class.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  * This file contains the generic moodleform bridge for the backup user interface
20  * as well as the individual forms that relate to the different stages the user
21  * interface can exist within.
22  *
23  * @package   moodlecore
24  * @copyright 2010 Sam Hemelryk
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 require_once($CFG->libdir . '/formslib.php');
32 /**
33  * Backup moodleform bridge
34  *
35  * Ahhh the mighty moodleform bridge! Strong enough to take the weight of 682 full
36  * grown african swallows all of whom have been carring coconuts for several days.
37  * EWWWWW!!!!!!!!!!!!!!!!!!!!!!!!
38  *
39  * @copyright 2010 Sam Hemelryk
40  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 abstract class base_moodleform extends moodleform {
43     /**
44      * The stage this form belongs to
45      * @var base_ui_stage
46      */
47     protected $uistage = null;
48     /**
49      * True if we have a course div open, false otherwise
50      * @var bool
51      */
52     protected $coursediv = false;
53     /**
54      * True if we have a section div open, false otherwise
55      * @var bool
56      */
57     protected $sectiondiv = false;
58     /**
59      * True if we have an activity div open, false otherwise
60      * @var bool
61      */
62     protected $activitydiv = false;
63     /**
64      * Creates the form
65      *
66      * @param backup_ui_stage $uistage
67      * @param moodle_url|string $action
68      * @param mixed $customdata
69      * @param string $method get|post
70      * @param string $target
71      * @param array $attributes
72      * @param bool $editable
73      */
74     function __construct(base_ui_stage $uistage, $action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true) {
75         $this->uistage = $uistage;
76         parent::__construct($action, $customdata, $method, $target, $attributes, $editable);
77     }
78     /**
79      * The standard form definition... obviously not much here
80      */
81     function definition() {
82         $ui = $this->uistage->get_ui();
83         $mform = $this->_form;
84         $stage = $mform->addElement('hidden', 'stage', $this->uistage->get_stage());
85         $stage = $mform->addElement('hidden', $ui->get_name(), $ui->get_uniqueid());
86         $params = $this->uistage->get_params();
87         if (is_array($params) && count($params) > 0) {
88             foreach ($params as $name=>$value) {
89                 $stage = $mform->addElement('hidden', $name, $value);
90             }
91         }
92     }
93     /**
94      * Definition applied after the data is organised.. why's it here? because I want
95      * to add elements on the fly.
96      * @global moodle_page $PAGE
97      */
98     function definition_after_data() {
99         global $PAGE;
100         $buttonarray=array();
101         $buttonarray[] = $this->_form->createElement('submit', 'submitbutton', get_string($this->uistage->get_ui()->get_name().'stage'.$this->uistage->get_stage().'action', 'backup'), array('class'=>'proceedbutton'));
102         if (!$this->uistage->is_first_stage()) {
103             $buttonarray[] = $this->_form->createElement('submit', 'previous', get_string('previousstage','backup'));
104         }
105         $buttonarray[] = $this->_form->createElement('cancel', 'cancel', get_string('cancel'), array('class'=>'confirmcancel'));
106         $this->_form->addGroup($buttonarray, 'buttonar', '', array(' '), false);
107         $this->_form->closeHeaderBefore('buttonar');
109         $config = new stdClass;
110         $config->title = get_string('confirmcancel', 'backup');
111         $config->question = get_string('confirmcancelquestion', 'backup');
112         $config->yesLabel = get_string('confirmcancelyes', 'backup');
113         $config->noLabel = get_string('confirmcancelno', 'backup');
114         $PAGE->requires->yui_module('moodle-backup-confirmcancel', 'M.core_backup.watch_cancel_buttons', array($config));
115     }
116     /**
117      * Closes any open divs
118      */
119     function close_task_divs() {
120         if ($this->activitydiv) {
121             $this->_form->addElement('html', html_writer::end_tag('div'));
122             $this->activitydiv = false;
123         }
124         if ($this->sectiondiv) {
125             $this->_form->addElement('html', html_writer::end_tag('div'));
126             $this->sectiondiv = false;
127         }
128         if ($this->coursediv) {
129             $this->_form->addElement('html', html_writer::end_tag('div'));
130             $this->coursediv = false;
131         }
132     }
133     /**
134      * Adds the backup_setting as a element to the form
135      * @param backup_setting $setting
136      * @return bool
137      */
138     function add_setting(backup_setting $setting, base_task $task=null) {
139         global $OUTPUT;
141         // If the setting cant be changed or isn't visible then add it as a fixed setting.
142         if (!$setting->get_ui()->is_changeable() || $setting->get_visibility() != backup_setting::VISIBLE) {
143             return $this->add_fixed_setting($setting, $task);
144         }
146         // First add the formatting for this setting
147         $this->add_html_formatting($setting);
149         // The call the add method with the get_element_properties array
150         call_user_func_array(array($this->_form, 'addElement'), $setting->get_ui()->get_element_properties($task, $OUTPUT));
151         $this->_form->setDefault($setting->get_ui_name(), $setting->get_value());
152         if ($setting->has_help()) {
153             list($identifier, $component) = $setting->get_help();
154             $this->_form->addHelpButton($setting->get_ui_name(), $identifier, $component);
155         }
156         $this->_form->addElement('html', html_writer::end_tag('div'));
157         return true;
158     }
159     /**
160      * Adds multiple backup_settings as elements to the form
161      * @param array $settingstasks Consists of array($setting, $task) elements
162      * @return bool
163      */
164     function add_settings(array $settingstasks) {
165         global $OUTPUT;
167         $defaults = array();
168         foreach ($settingstasks as $st) {
169             list($setting, $task) = $st;
170             // If the setting cant be changed or isn't visible then add it as a fixed setting.
171             if (!$setting->get_ui()->is_changeable() || $setting->get_visibility() != backup_setting::VISIBLE) {
172                 $this->add_fixed_setting($setting, $task);
173                 continue;
174             }
176             // First add the formatting for this setting
177             $this->add_html_formatting($setting);
179             // Then call the add method with the get_element_properties array
180             call_user_func_array(array($this->_form, 'addElement'), $setting->get_ui()->get_element_properties($task, $OUTPUT));
181             $defaults[$setting->get_ui_name()] = $setting->get_value();
182             if ($setting->has_help()) {
183                 list($identifier, $component) = $setting->get_help();
184                 $this->_form->addHelpButton($setting->get_ui_name(), $identifier, $component);
185             }
186             $this->_form->addElement('html', html_writer::end_tag('div'));
187         }
188         $this->_form->setDefaults($defaults);
189         return true;
190     }
191     /**
192      * Adds a heading to the form
193      * @param string $name
194      * @param string $text
195      */
196     function add_heading($name , $text) {
197         $this->_form->addElement('header', $name, $text);
198     }
199     /**
200      * Adds HTML formatting for the given backup setting, needed to group/segment
201      * correctly.
202      * @param backup_setting $setting
203      */
204     protected function add_html_formatting(backup_setting $setting) {
205         $mform = $this->_form;
206         $isincludesetting = (strpos($setting->get_name(), '_include')!==false);
207         if ($isincludesetting && $setting->get_level() != backup_setting::ROOT_LEVEL)  {
208             switch ($setting->get_level()) {
209                 case backup_setting::COURSE_LEVEL:
210                     if ($this->activitydiv) {
211                         $this->_form->addElement('html', html_writer::end_tag('div'));
212                         $this->activitydiv = false;
213                     }
214                     if ($this->sectiondiv) {
215                         $this->_form->addElement('html', html_writer::end_tag('div'));
216                         $this->sectiondiv = false;
217                     }
218                     if ($this->coursediv) {
219                         $this->_form->addElement('html', html_writer::end_tag('div'));
220                     }
221                     $mform->addElement('html', html_writer::start_tag('div', array('class'=>'grouped_settings course_level')));
222                     $mform->addElement('html', html_writer::start_tag('div', array('class'=>'include_setting course_level')));
223                     $this->coursediv = true;
224                     break;
225                 case backup_setting::SECTION_LEVEL:
226                     if ($this->activitydiv) {
227                         $this->_form->addElement('html', html_writer::end_tag('div'));
228                         $this->activitydiv = false;
229                     }
230                     if ($this->sectiondiv) {
231                         $this->_form->addElement('html', html_writer::end_tag('div'));
232                     }
233                     $mform->addElement('html', html_writer::start_tag('div', array('class'=>'grouped_settings section_level')));
234                     $mform->addElement('html', html_writer::start_tag('div', array('class'=>'include_setting section_level')));
235                     $this->sectiondiv = true;
236                     break;
237                 case backup_setting::ACTIVITY_LEVEL:
238                     if ($this->activitydiv) {
239                         $this->_form->addElement('html', html_writer::end_tag('div'));
240                     }
241                     $mform->addElement('html', html_writer::start_tag('div', array('class'=>'grouped_settings activity_level')));
242                     $mform->addElement('html', html_writer::start_tag('div', array('class'=>'include_setting activity_level')));
243                     $this->activitydiv = true;
244                     break;
245                 default:
246                     $mform->addElement('html', html_writer::start_tag('div', array('class'=>'normal_setting')));
247                     break;
248             }
249         } else if ($setting->get_level() == backup_setting::ROOT_LEVEL) {
250             $mform->addElement('html', html_writer::start_tag('div', array('class'=>'root_setting')));
251         } else {
252             $mform->addElement('html', html_writer::start_tag('div', array('class'=>'normal_setting')));
253         }
254     }
255     /**
256      * Adds a fixed or static setting to the form
257      * @param backup_setting $setting
258      */
259     function add_fixed_setting(backup_setting $setting, base_task $task) {
260         global $OUTPUT;
261         $settingui = $setting->get_ui();
262         if ($setting->get_visibility() == backup_setting::VISIBLE) {
263             $this->add_html_formatting($setting);
264             switch ($setting->get_status()) {
265                 case backup_setting::LOCKED_BY_PERMISSION:
266                     $icon = ' '.$OUTPUT->pix_icon('i/permissionlock', get_string('lockedbypermission', 'backup'), 'moodle', array('class'=>'smallicon lockedicon permissionlock'));
267                     break;
268                 case backup_setting::LOCKED_BY_CONFIG:
269                     $icon = ' '.$OUTPUT->pix_icon('i/configlock', get_string('lockedbyconfig', 'backup'), 'moodle', array('class'=>'smallicon lockedicon configlock'));
270                     break;
271                 case backup_setting::LOCKED_BY_HIERARCHY:
272                     $icon = ' '.$OUTPUT->pix_icon('i/hierarchylock', get_string('lockedbyhierarchy', 'backup'), 'moodle', array('class'=>'smallicon lockedicon configlock'));
273                     break;
274                 default:
275                     $icon = '';
276                     break;
277             }
278             $label = $settingui->get_label($task);
279             $labelicon = $settingui->get_icon();
280             if (!empty($labelicon)) {
281                 $label .= '&nbsp;'.$OUTPUT->render($labelicon);
282             }
283             $this->_form->addElement('static', 'static_'.$settingui->get_name(), $label, $settingui->get_static_value().$icon);
284             $this->_form->addElement('html', html_writer::end_tag('div'));
285         }
286         $this->_form->addElement('hidden', $settingui->get_name(), $settingui->get_value());
287     }
288     /**
289      * Adds dependencies to the form recursively
290      *
291      * @param backup_setting $setting
292      */
293     function add_dependencies(backup_setting $setting) {
294         $mform = $this->_form;
295         // Apply all dependencies for backup
296         foreach ($setting->get_my_dependency_properties() as $key=>$dependency) {
297             call_user_func_array(array($this->_form, 'disabledIf'), $dependency);
298         }
299     }
300     /**
301      * Returns true if the form was cancelled, false otherwise
302      * @return bool
303      */
304     public function is_cancelled() {
305         return (optional_param('cancel', false, PARAM_BOOL) || parent::is_cancelled());
306     }
308     /**
309      * Removes an element from the form if it exists
310      * @param string $elementname
311      * @return bool
312      */
313     public function remove_element($elementname) {
314         if ($this->_form->elementExists($elementname)) {
315             return $this->_form->removeElement($elementname);
316         } else {
317             return false;
318         }
319     }
321     /**
322      * Gets an element from the form if it exists
323      *
324      * @param string $elementname
325      * @return HTML_QuickForm_input|MoodleQuickForm_group
326      */
327     public function get_element($elementname) {
328         if ($this->_form->elementExists($elementname)) {
329             return $this->_form->getElement($elementname);
330         } else {
331             return false;
332         }
333     }
335     /**
336      * Displays the form
337      */
338     public function display() {
339         $this->require_definition_after_data();
340         parent::display();
341     }
343     /**
344      * Ensures the the definition after data is loaded
345      */
346     public function require_definition_after_data() {
347         if (!$this->_definition_finalized) {
348             $this->_definition_finalized = true;
349             $this->definition_after_data();
350         }
351     }