forked from drachels/moodle-mod_mootyper
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmod_form.php
executable file
·417 lines (354 loc) · 18.4 KB
/
mod_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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
<?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/>.
/**
* The main mootyper configuration form
*
* It uses the standard core Moodle formslib. For more info about them, please
* visit: http://docs.moodle.org/en/Development:lib/formslib.php
*
* @package mod_mootyper
* @copyright 2012 Jaka Luthar ([email protected])
* @copyright 2016 onwards AL Rachels ([email protected])
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
if (!defined('MOODLE_INTERNAL')) {
// It must be included from a Moodle page
die('Direct access to this script is forbidden.');
}
require_once($CFG->dirroot.'/course/moodleform_mod.php');
use \mod_mootyper\local\keyboards;
use core_grades\component_gradeitems;
/**
* Module instance settings form.
*
* @package mod_mootyper
* @copyright 2012 Jaka Luthar ([email protected])
* @copyright 2016 onwards AL Rachels ([email protected])
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
class mod_mootyper_mod_form extends moodleform_mod {
/**
* @var $course Protected modifier.
*/
protected $course = null;
/**
* Define the MooTyper mod_form.
*/
public function definition() {
global $CFG, $COURSE, $DB;
$mform =& $this->_form;
// 20200630 Added to fix link to control access to the management link.
$id = optional_param('update', 0, PARAM_INT); // Course module ID.
$mootyperconfig = get_config('mod_mootyper');
$mform->addElement('header', 'general', get_string('general', 'form'));
$mform->addElement('text', 'name', get_string('name'), array('size' => '64'));
if (!empty($CFG->formatstringstriptags)) {
$mform->setType('name', PARAM_TEXT);
} else {
$mform->setType('name', PARAM_CLEAN);
}
$mform->addRule('name', null, 'required', null, 'client');
$mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
$mform->addHelpButton('name', 'mootypername', 'mootyper');
if ($CFG->branch > 28) {
$this->standard_intro_elements();
} else {
$this->add_intro_editor();
}
// MooTyper activity setup, Availability settings.
$mform->addElement('header', 'availabilityhdr', get_string('availability'));
$mform->addElement('date_time_selector', 'timeopen',
get_string('mootyperopentime', 'mootyper'),
array('optional' => true, 'step' => 1));
$mform->addElement('date_time_selector', 'timeclose',
get_string('mootyperclosetime', 'mootyper'),
array('optional' => true, 'step' => 1));
// MooTyper activity password setup.
$mform->addElement('selectyesno', 'usepassword', get_string('usepassword', 'mootyper'));
$mform->addHelpButton('usepassword', 'usepassword', 'mootyper');
$mform->setDefault('usepassword', $mootyperconfig->password);
$mform->setAdvanced('usepassword', $mootyperconfig->password_adv);
$mform->addElement('passwordunmask', 'password', get_string('password', 'mootyper'));
$mform->setDefault('password', '');
$mform->setAdvanced('password', $mootyperconfig->password_adv);
$mform->setType('password', PARAM_RAW);
$mform->disabledIf('password', 'usepassword', 'eq', 0);
$mform->disabledIf('passwordunmask', 'usepassword', 'eq', 0);
// MooTyper activity setup, Options settings.
$mform->addElement('header', 'optionhdr', get_string('options', 'mootyper'));
/* TODO: Add a dropdown selector for isexam (the activity mode).
$modes = array(get_string('sflesson', 'mod_mootyper'),
get_string('isexamtext', 'mod_mootyper'),
get_string('practice', 'mod_mootyper'));
$mform->addElement('select', 'isexam', get_string('fmode', 'mootyper'), $modes);
$mform->addHelpButton('isexam', 'fmode', 'mootyper');
$mform->setDefault('isexam', $mootyperconfig->isexam);
*/
// TODO: Add a dropdown selector of lesson/category.
// 20191223 Added a dropdown slector for timelimit.
$tlimit = array();
for ($i = 0; $i <= 10; $i++) {
$tlimit[] = $i;
}
$mform->addElement('select', 'timelimit', get_string('timelimit', 'mootyper'), $tlimit);
$mform->addHelpButton('timelimit', 'timelimit', 'mootyper');
$mform->setDefault('timelimit', $mootyperconfig->defaulttimelimit);
// Added a dropdown slector for Required precision. 11/25/17.
$precs = array();
for ($i = 0; $i <= 100; $i++) {
$precs[] = $i;
}
$mform->addElement('select', 'requiredgoal', get_string('requiredgoal', 'mootyper'), $precs);
$mform->addHelpButton('requiredgoal', 'requiredgoal', 'mootyper');
$mform->setDefault('requiredgoal', $mootyperconfig->defaultprecision);
// 20191214 Added a dropdown slector for WPM rate.
$wpm = array();
for ($i = 0; $i <= 100; $i++) {
$wpm[] = $i;
}
$mform->addElement('select', 'requiredwpm', get_string('requiredwpm', 'mootyper'), $wpm);
$mform->addHelpButton('requiredwpm', 'requiredwpm', 'mootyper');
$mform->setDefault('requiredwpm', $mootyperconfig->defaultwpm);
// Add a dropdown slector for text alignment.
$aligns = array(get_string('defaulttextalign_left', 'mod_mootyper'),
get_string('defaulttextalign_center', 'mod_mootyper'),
get_string('defaulttextalign_right', 'mod_mootyper'));
$mform->addElement('select', 'textalign', get_string('defaulttextalign', 'mootyper'), $aligns);
$mform->addHelpButton('textalign', 'defaulttextalign', 'mootyper');
$mform->setDefault('textalign', $mootyperconfig->defaulttextalign);
// Continuous typing setup.
$mform->addElement('selectyesno', 'continuoustype', get_string('continuoustype', 'mootyper'));
$mform->addHelpButton('continuoustype', 'continuoustype', 'mootyper');
$mform->setDefault('continuoustype', $mootyperconfig->continuoustype);
$mform->setAdvanced('continuoustype', $mootyperconfig->continuoustype_adv);
// Count mistyped spaces setup.
$mform->addElement('selectyesno', 'countmistypedspaces', get_string('countmistypedspaces', 'mootyper'));
$mform->addHelpButton('countmistypedspaces', 'countmistypedspaces', 'mootyper');
$mform->setDefault('countmistypedspaces', $mootyperconfig->countmistypedspaces);
$mform->setAdvanced('countmistypedspaces', $mootyperconfig->countmistypedspaces_adv);
// Count mistakes setup.
$mform->addElement('selectyesno', 'countmistakes', get_string('countmistakes', 'mootyper'));
$mform->addHelpButton('countmistakes', 'countmistakes', 'mootyper');
$mform->setDefault('countmistakes', $mootyperconfig->countmistakes);
$mform->setAdvanced('countmistakes', $mootyperconfig->countmistakes_adv);
// Show keyboard setup.
$mform->addElement('selectyesno', 'showkeyboard', get_string('showkeyboard', 'mootyper'));
$mform->addHelpButton('showkeyboard', 'showkeyboard', 'mootyper');
$mform->setDefault('showkeyboard', $mootyperconfig->showkeyboard);
$mform->setAdvanced('showkeyboard', $mootyperconfig->showkeyboard_adv);
// 20171122 Add a dropdown slector for keyboard layouts.
// Use function in localib.php to get layouts.
$layouts = keyboards::get_keyboard_layouts_db();
$mform->addElement('select', 'layout', get_string('layout', 'mootyper'), $layouts);
$mform->addHelpButton('layout', 'layout', 'mootyper');
$mform->setDefault('layout', $mootyperconfig->defaultlayout);
// Add setting for statistics bar background color.
$attributes = 'size = "20"';
$mform->setType('statsbgc', PARAM_NOTAGS);
$mform->addElement('text', 'statsbgc', get_string('statsbgc', 'mootyper'), $attributes);
$mform->addHelpButton('statsbgc', 'statsbgc', 'mootyper');
$mform->setDefault('statsbgc', $mootyperconfig->statscolor);
// Add setting for keytoptextc color setting. 12/15/19.
$mform->setType('keytoptextc', PARAM_NOTAGS);
$mform->addElement('text', 'keytoptextc', get_string('keytoptextc', 'mootyper'), $attributes);
$mform->addHelpButton('keytoptextc', 'keytoptextc', 'mootyper');
$mform->setDefault('keytoptextc', $mootyperconfig->normalkeytoptextc);
// Add setting for keytop background color.
$mform->setType('keytopbgc', PARAM_NOTAGS);
$mform->addElement('text', 'keytopbgc', get_string('keytopbgc', 'mootyper'), $attributes);
$mform->addHelpButton('keytopbgc', 'keytopbgc', 'mootyper');
$mform->setDefault('keytopbgc', $mootyperconfig->normalkeytops);
// Add setting for keyboard background color.
$mform->setType('keybdbgc', PARAM_NOTAGS);
$mform->addElement('text', 'keybdbgc', get_string('keybdbgc', 'mootyper'), $attributes);
$mform->addHelpButton('keybdbgc', 'keybdbgc', 'mootyper');
$mform->setDefault('keybdbgc', $mootyperconfig->keyboardbgc);
// Add setting for cursor color.
$mform->setType('cursorcolor', PARAM_NOTAGS);
$mform->addElement('text', 'cursorcolor', get_string('cursorcolor', 'mootyper'), $attributes);
$mform->addHelpButton('cursorcolor', 'cursorcolor', 'mootyper');
$mform->setDefault('cursorcolor', $mootyperconfig->cursorcolor);
// Add setting for texttotype background color.
$mform->setType('textbgc', PARAM_NOTAGS);
$mform->addElement('text', 'textbgc', get_string('textbgc', 'mootyper'), $attributes);
$mform->addHelpButton('textbgc', 'textbgc', 'mootyper');
$mform->setDefault('textbgc', $mootyperconfig->textbgc);
// Add setting for mistyped text background color.
$mform->setType('texterrorcolor', PARAM_NOTAGS);
$mform->addElement('text', 'texterrorcolor', get_string('texterrorcolor', 'mootyper'), $attributes);
$mform->addHelpButton('texterrorcolor', 'texterrorcolor', 'mootyper');
$mform->setDefault('texterrorcolor', $mootyperconfig->texterrorcolor);
// MooTyper activity, link to Lesson/Categories and exercises.
// 20200630 When a cmid is available, show the link.
if ($id) {
$mform->addElement('header', 'mootyperz', get_string('pluginadministration', 'mootyper'));
$jlnk3 = $CFG->wwwroot . '/mod/mootyper/exercises.php?id='.$id;
$mform->addElement('html', '<a id="jlnk3" href="'.$jlnk3.'">'.get_string('emanage', 'mootyper').'</a>');
}
// 20200907 Add mootyper grading options for the whole activity.
if ($CFG->branch > 37) {
$this->add_mootyper_grade_settings($mform, 'mootyper');
}
// The rest of the common activity settings.
$this->standard_grading_coursemodule_elements();
$this->standard_coursemodule_elements();
$this->apply_admin_defaults();
$this->add_action_buttons();
}
/**
* Add the whole mootyper grade settings to the mform.
*
* @param \mform $mform
* @param string $itemname
*/
private function add_mootyper_grade_settings($mform, string $itemname) {
global $COURSE;
$component = "mod_{$this->_modname}";
$defaultgradingvalue = 0;
$itemnumber = component_gradeitems::get_itemnumber_from_itemname($component, $itemname);
$gradefieldname = component_gradeitems::get_field_name_for_itemnumber($component, $itemnumber, 'grade');
$gradecatfieldname = component_gradeitems::get_field_name_for_itemnumber($component, $itemnumber, 'gradecat');
$gradepassfieldname = component_gradeitems::get_field_name_for_itemnumber($component, $itemnumber, 'gradepass');
$sendstudentnotificationsfieldname = component_gradeitems::get_field_name_for_itemnumber($component, $itemnumber,
'sendstudentnotifications');
// The advancedgradingmethod is different in that it is suffixed with an area name... which is not the
// itemnumber.
$methodfieldname = "advancedgradingmethod_{$itemname}";
$headername = "{$gradefieldname}_header";
$mform->addElement('header', $headername, get_string("grade_{$itemname}_header", $component));
$isupdate = !empty($this->_cm);
$gradeoptions = [
'isupdate' => $isupdate,
'currentgrade' => false,
'hasgrades' => false,
'canrescale' => false,
'useratings' => false,
];
if ($isupdate) {
$gradeitem = grade_item::fetch([
'itemtype' => 'mod',
'itemmodule' => $this->_cm->modname,
'iteminstance' => $this->_cm->instance,
'itemnumber' => $itemnumber,
'courseid' => $COURSE->id,
]);
if ($gradeitem) {
$gradeoptions['currentgrade'] = $gradeitem->grademax;
$gradeoptions['currentgradetype'] = $gradeitem->gradetype;
$gradeoptions['currentscaleid'] = $gradeitem->scaleid;
$gradeoptions['hasgrades'] = $gradeitem->has_grades();
}
}
$mform->addElement(
'modgrade',
$gradefieldname,
get_string("{$gradefieldname}_title", $component),
$gradeoptions
);
$mform->addHelpButton($gradefieldname, 'modgrade', 'grades');
$mform->setDefault($gradefieldname, $defaultgradingvalue);
if (!empty($this->current->_advancedgradingdata['methods']) && !empty($this->current->_advancedgradingdata['areas'])) {
$areadata = $this->current->_advancedgradingdata['areas'][$itemname];
$mform->addElement(
'select',
$methodfieldname,
get_string('gradingmethod', 'core_grading'),
$this->current->_advancedgradingdata['methods']
);
$mform->addHelpButton($methodfieldname, 'gradingmethod', 'core_grading');
$mform->hideIf($methodfieldname, "{$gradefieldname}[modgrade_type]", 'eq', 'none');
}
// Grade category.
$mform->addElement(
'select',
$gradecatfieldname,
get_string('gradecategoryonmodform', 'grades'),
grade_get_categories_menu($COURSE->id, $this->_outcomesused)
);
$mform->addHelpButton($gradecatfieldname, 'gradecategoryonmodform', 'grades');
$mform->hideIf($gradecatfieldname, "{$gradefieldname}[modgrade_type]", 'eq', 'none');
// Grade to pass.
$mform->addElement('text', $gradepassfieldname, get_string('gradepass', 'grades'));
$mform->addHelpButton($gradepassfieldname, 'gradepass', 'grades');
$mform->setDefault($gradepassfieldname, '');
$mform->setType($gradepassfieldname, PARAM_RAW);
$mform->hideIf($gradepassfieldname, "{$gradefieldname}[modgrade_type]", 'eq', 'none');
}
/**
* Handle definition after data for grade settings.
*
* @param array $data
* @param array $files
* @param array $errors
*/
private function validation_mootyper_grade(array $data, array $files, array $errors) {
global $COURSE;
$mform =& $this->_form;
$component = "mod_mootyper";
$itemname = 'mootyper';
$itemnumber = component_gradeitems::get_itemnumber_from_itemname($component, $itemname);
$gradefieldname = component_gradeitems::get_field_name_for_itemnumber($component, $itemnumber, 'grade');
$gradepassfieldname = component_gradeitems::get_field_name_for_itemnumber($component, $itemnumber, 'grade');
$gradeitem = grade_item::fetch([
'itemtype' => 'mod',
'itemmodule' => $data['modulename'],
'iteminstance' => $data['instance'],
'itemnumber' => $itemnumber,
'courseid' => $COURSE->id,
]);
if ($mform->elementExists('cmidnumber') && $this->_cm) {
if (!grade_verify_idnumber($data['cmidnumber'], $COURSE->id, $gradeitem, $this->_cm)) {
$errors['cmidnumber'] = get_string('idnumbertaken');
}
}
// Check that the grade pass is a valid number.
$gradepassvalid = false;
if (isset($data[$gradepassfieldname])) {
if (unformat_float($data[$gradepassfieldname], true) === false) {
$errors[$gradepassfieldname] = get_string('err_numeric', 'form');
} else {
$gradepassvalid = true;
}
}
// Grade to pass: ensure that the grade to pass is valid for points and scales.
// If we are working with a scale, convert into a positive number for validation.
if ($gradepassvalid && isset($data[$gradepassfieldname]) && (!empty($data[$gradefieldname]))) {
$grade = $data[$gradefieldname];
if (unformat_float($data[$gradepassfieldname]) > $grade) {
$errors[$gradepassfieldname] = get_string('gradepassgreaterthangrade', 'grades', $grade);
}
}
}
/**
* Enforce validation rules here.
*
* @param array $data Post data to validate
* @param array $files
* @return array
**/
public function validation($data, $files) {
$errors = parent::validation($data, $files);
// Check open and close times are consistent.
if ($data['timeopen'] != 0 && $data['timeclose'] != 0 &&
$data['timeclose'] < $data['timeopen']) {
$errors['timeclose'] = get_string('closebeforeopen', 'mootyper');
}
if (!empty($data['usepassword']) && empty($data['password'])) {
$errors['password'] = get_string('emptypassword', 'mootyper');
}
return $errors;
}
}