-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathedit_form.php
219 lines (198 loc) · 8.92 KB
/
edit_form.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Checklist editor form
*
* @package gradingform
* @subpackage checklist
* @author Sam Chaffee
* @copyright 2011 Marina Glancy <[email protected]>
* @copyright Copyright (c) 2012 Open LMS (https://www.openlms.net)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->dirroot . '/lib/formslib.php');
require_once($CFG->dirroot . '/grade/grading/form/checklist/checklisteditor.php');
MoodleQuickForm::registerElementType('checklisteditor', $CFG->dirroot.'/grade/grading/form/checklist/checklisteditor.php', 'MoodleQuickForm_checklisteditor');
/**
* Defines the checklist edit form
*/
class gradingform_checklist_editchecklist extends moodleform {
/**
* Form element definition
*/
public function definition() {
$form = $this->_form;
$form->addElement('hidden', 'areaid');
$form->setType('areaid', PARAM_INT);
$form->addElement('hidden', 'returnurl');
$form->setType('returnurl', PARAM_LOCALURL);
// name
$form->addElement('text', 'name', get_string('name', 'gradingform_checklist'), array('size'=>52));
$form->addRule('name', get_string('required'), 'required');
$form->setType('name', PARAM_TEXT);
// description
$options = gradingform_checklist_controller::description_form_field_options($this->_customdata['context']);
$form->addElement('editor', 'description_editor', get_string('description', 'gradingform_checklist'), null, $options);
$form->setType('description_editor', PARAM_RAW);
// checklist completion status
$choices = array();
$choices[gradingform_controller::DEFINITION_STATUS_DRAFT] = html_writer::tag('span', get_string('statusdraft', 'core_grading'), array('class' => 'status draft'));
$choices[gradingform_controller::DEFINITION_STATUS_READY] = html_writer::tag('span', get_string('statusready', 'core_grading'), array('class' => 'status ready'));
$form->addElement('select', 'status', get_string('checkliststatus', 'gradingform_checklist'), $choices)->freeze();
// checklist editor
$element = $form->addElement('checklisteditor', 'checklist', get_string('checklist', 'gradingform_checklist'));
$form->setType('checklist', PARAM_RAW);
//$element->freeze(); // TODO freeze checklist editor if needed
$buttonarray = array();
$buttonarray[] = &$form->createElement('submit', 'savechecklist', get_string('savechecklist', 'gradingform_checklist'));
if ($this->_customdata['allowdraft']) {
$buttonarray[] = &$form->createElement('submit', 'savechecklistdraft', get_string('savechecklistdraft', 'gradingform_checklist'));
}
$editbutton = &$form->createElement('submit', 'editchecklist', ' ');
$editbutton->freeze();
$buttonarray[] = &$editbutton;
$buttonarray[] = &$form->createElement('cancel');
$form->addGroup($buttonarray, 'buttonar', '', array(' '), false);
$form->closeHeaderBefore('buttonar');
}
/**
* Setup the form depending on current values. This method is called after definition(),
* data submission and set_data().
* All form setup that is dependent on form values should go in here.
*
* We remove the element status if there is no current status (i.e. checklist is only being created)
* so the users do not get confused
*/
public function definition_after_data() {
$form = $this->_form;
$el = $form->getElement('status');
if (!$el->getValue()) {
$form->removeElement('status');
} else {
$vals = array_values($el->getValue());
if ($vals[0] == gradingform_controller::DEFINITION_STATUS_READY) {
$this->findButton('savechecklist')->setValue(get_string('save', 'gradingform_checklist'));
}
}
}
/**
* Form vlidation.
* If there are errors return array of errors ("fieldname"=>"error message"),
* otherwise true if ok.
*
* @param array $data array of ("fieldname"=>value) of submitted data
* @param array $files array of uploaded files "element_name"=>tmp_file_path
* @return array of "element_name"=>"error_description" if there are errors,
* or an empty array if everything is OK (true allowed for backwards compatibility too).
*/
public function validation($data, $files) {
$err = parent::validation($data, $files);
$err = array();
$form = $this->_form;
$checklistel = $form->getElement('checklist');
if ($checklistel->non_js_button_pressed($data['checklist'])) {
// if JS is disabled and button such as 'Add group' is pressed - prevent from submit
$err['checklistdummy'] = 1;
} else if (isset($data['editchecklist'])) {
// continue editing
$err['checklistdummy'] = 1;
} else if (isset($data['savechecklist']) && $data['savechecklist']) {
// If user attempts to make checklist active - it needs to be validated
if ($checklistel->validate($data['checklist']) !== false) {
$err['checklistdummy'] = 1;
}
}
return $err;
}
/**
* Return submitted data if properly submitted or returns NULL if validation fails or
* if there is no submitted data.
*
* @return object submitted data; NULL if not valid or not submitted or cancelled
*/
public function get_data() {
$data = parent::get_data();
if (!empty($data->savechecklist)) {
$data->status = gradingform_controller::DEFINITION_STATUS_READY;
} else if (!empty($data->savechecklistdraft)) {
$data->status = gradingform_controller::DEFINITION_STATUS_DRAFT;
}
return $data;
}
/**
* Check if there are changes in the checklist and it is needed to ask user whether to
* mark the current grades for re-grading. User may confirm re-grading and continue,
* return to editing or cancel the changes
*
* @param gradingform_checklist_controller $controller
* @return boolean
*/
public function need_confirm_regrading($controller) {
$data = $this->get_data();
if (isset($data->checklist['regrade'])) {
// we have already displayed the confirmation on the previous step
return false;
}
if (!isset($data->savechecklist) || !$data->savechecklist) {
// we only need confirmation when button 'Save checklist' is pressed
return false;
}
if (!$controller->has_active_instances()) {
// nothing to re-grade, confirmation not needed
return false;
}
$changelevel = $controller->update_or_check_checklist($data);
if ($changelevel == 0) {
// no changes in the checklist, no confirmation needed
return false;
}
// freeze form elements and pass the values in hidden fields
// TODO description_editor does not freeze the normal way!
$form = $this->_form;
foreach (array('checklist', 'name'/*, 'description_editor'*/) as $fieldname) {
$el =& $form->getElement($fieldname);
$el->freeze();
$el->setPersistantFreeze(true);
if ($fieldname == 'checklist') {
$el->add_regrade_confirmation($changelevel);
}
}
// replace button text 'savechecklist' and unfreeze 'Back to edit' button
$this->findButton('savechecklist')->setValue(get_string('continue'));
$el =& $this->findButton('editchecklist');
$el->setValue(get_string('backtoediting', 'gradingform_checklist'));
$el->unfreeze();
return true;
}
/**
* Returns a form element (submit button) with the name $elementname
*
* @param string $elementname
* @return HTML_QuickForm_element
*/
protected function &findButton($elementname) {
$form = $this->_form;
$buttonar =& $form->getElement('buttonar');
$elements =& $buttonar->getElements();
foreach ($elements as $el) {
if ($el->getName() == $elementname) {
return $el;
}
}
return null;
}
}