2 require_once ($CFG->libdir
.'/formslib.php');
3 require_once($CFG->libdir
.'/completionlib.php');
6 * This class adds extra methods to form wrapper specific to be used for module
7 * add / update forms mod/{modname}/mod_form.php replaced deprecated mod/{modname}/mod.html
9 abstract class moodleform_mod
extends moodleform
{
13 * Instance of the module that is being updated. This is the id of the {prefix}{modulename}
14 * record. Can be used in form definition. Will be "" if this is an 'add' form and not an
21 * Section of course that module instance will be put in or is in.
22 * This is always the section number itself (column 'section' from 'course_sections' table).
28 * Course module record of the module that is being updated. Will be null if this is an 'add' form and not an
35 * List of modform features
39 * @var array Custom completion-rule elements, if enabled
41 protected $_customcompletionelements;
43 * @var string name of module
46 /** current context, course or module depends if already exists*/
49 /** a flag indicating whether outcomes are being used*/
50 protected $_outcomesused;
52 function moodleform_mod($current, $section, $cm, $course) {
53 $this->current
= $current;
54 $this->_instance
= $current->instance
;
55 $this->_section
= $section;
58 $this->context
= context_module
::instance($this->_cm
->id
);
60 $this->context
= context_course
::instance($course->id
);
65 if (!preg_match('/^mod_([^_]+)_mod_form$/', get_class($this), $matches)) {
66 debugging('Use $modname parameter or rename form to mod_xx_mod_form, where xx is name of your module');
67 print_error('unknownmodulename');
69 $this->_modname
= $matches[1];
70 $this->init_features();
71 parent
::moodleform('modedit.php');
74 protected function init_features() {
77 $this->_features
= new stdClass();
78 $this->_features
->groups
= plugin_supports('mod', $this->_modname
, FEATURE_GROUPS
, true);
79 $this->_features
->groupings
= plugin_supports('mod', $this->_modname
, FEATURE_GROUPINGS
, false);
80 $this->_features
->groupmembersonly
= (!empty($CFG->enablegroupmembersonly
) and plugin_supports('mod', $this->_modname
, FEATURE_GROUPMEMBERSONLY
, false));
81 $this->_features
->outcomes
= (!empty($CFG->enableoutcomes
) and plugin_supports('mod', $this->_modname
, FEATURE_GRADE_OUTCOMES
, true));
82 $this->_features
->hasgrades
= plugin_supports('mod', $this->_modname
, FEATURE_GRADE_HAS_GRADE
, false);
83 $this->_features
->idnumber
= plugin_supports('mod', $this->_modname
, FEATURE_IDNUMBER
, true);
84 $this->_features
->introeditor
= plugin_supports('mod', $this->_modname
, FEATURE_MOD_INTRO
, true);
85 $this->_features
->defaultcompletion
= plugin_supports('mod', $this->_modname
, FEATURE_MODEDIT_DEFAULT_COMPLETION
, true);
86 $this->_features
->rating
= plugin_supports('mod', $this->_modname
, FEATURE_RATE
, false);
87 $this->_features
->showdescription
= plugin_supports('mod', $this->_modname
, FEATURE_SHOW_DESCRIPTION
, false);
89 $this->_features
->gradecat
= ($this->_features
->outcomes
or $this->_features
->hasgrades
);
90 $this->_features
->advancedgrading
= plugin_supports('mod', $this->_modname
, FEATURE_ADVANCED_GRADING
, false);
94 * Only available on moodleform_mod.
96 * @param array $default_values passed by reference
98 function data_preprocessing(&$default_values){
99 if (empty($default_values['scale'])) {
100 $default_values['assessed'] = 0;
103 if (empty($default_values['assessed'])){
104 $default_values['ratingtime'] = 0;
106 $default_values['ratingtime']=
107 ($default_values['assesstimestart'] && $default_values['assesstimefinish']) ?
1 : 0;
112 * Each module which defines definition_after_data() must call this method using parent::definition_after_data();
114 function definition_after_data() {
115 global $CFG, $COURSE;
116 $mform =& $this->_form
;
118 if ($id = $mform->getElementValue('update')) {
119 $modulename = $mform->getElementValue('modulename');
120 $instance = $mform->getElementValue('instance');
122 if ($this->_features
->gradecat
) {
124 if (!empty($CFG->enableoutcomes
) and $this->_features
->outcomes
) {
125 $outcomes = grade_outcome
::fetch_all_available($COURSE->id
);
126 if (!empty($outcomes)) {
131 $items = grade_item
::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,'iteminstance'=>$instance, 'courseid'=>$COURSE->id
));
132 //will be no items if, for example, this activity supports ratings but rating aggregate type == no ratings
133 if (!empty($items)) {
134 foreach ($items as $item) {
135 if (!empty($item->outcomeid
)) {
136 $elname = 'outcome_'.$item->outcomeid
;
137 if ($mform->elementExists($elname)) {
138 $mform->hardFreeze($elname); // prevent removing of existing outcomes
143 foreach ($items as $item) {
144 if (is_bool($gradecat)) {
145 $gradecat = $item->categoryid
;
148 if ($gradecat != $item->categoryid
) {
156 if ($gradecat === false) {
157 // items and outcomes in different categories - remove the option
158 // TODO: add a "Mixed categories" text instead of removing elements with no explanation
159 if ($mform->elementExists('gradecat')) {
160 $mform->removeElement('gradecat');
161 if ($this->_features
->rating
) {
162 //if supports ratings then the max grade dropdown wasnt added so the grade box can be removed entirely
163 $mform->removeElement('modstandardgrade');
170 if ($COURSE->groupmodeforce
) {
171 if ($mform->elementExists('groupmode')) {
172 $mform->hardFreeze('groupmode'); // groupmode can not be changed if forced from course settings
176 // Don't disable/remove groupingid if it is currently set to something,
177 // otherwise you cannot turn it off at same time as turning off other
178 // option (MDL-30764)
179 if (empty($this->_cm
) ||
!$this->_cm
->groupingid
) {
180 if ($mform->elementExists('groupmode') and !$mform->elementExists('groupmembersonly') and empty($COURSE->groupmodeforce
)) {
181 $mform->disabledIf('groupingid', 'groupmode', 'eq', NOGROUPS
);
183 } else if (!$mform->elementExists('groupmode') and $mform->elementExists('groupmembersonly')) {
184 $mform->disabledIf('groupingid', 'groupmembersonly', 'notchecked');
186 } else if (!$mform->elementExists('groupmode') and !$mform->elementExists('groupmembersonly')) {
187 // groupings have no use without groupmode or groupmembersonly
188 if ($mform->elementExists('groupingid')) {
189 $mform->removeElement('groupingid');
194 // Completion: If necessary, freeze fields
195 $completion = new completion_info($COURSE);
196 if ($completion->is_enabled()) {
197 // If anybody has completed the activity, these options will be 'locked'
198 $completedcount = empty($this->_cm
)
200 : $completion->count_user_data($this->_cm
);
203 if (!$completedcount) {
204 if ($mform->elementExists('unlockcompletion')) {
205 $mform->removeElement('unlockcompletion');
207 // Automatically set to unlocked (note: this is necessary
208 // in order to make it recalculate completion once the option
209 // is changed, maybe someone has completed it now)
210 $mform->getElement('completionunlocked')->setValue(1);
212 // Has the element been unlocked?
213 if ($mform->exportValue('unlockcompletion')) {
214 // Yes, add in warning text and set the hidden variable
215 $mform->insertElementBefore(
216 $mform->createElement('static', 'completedunlocked',
217 get_string('completedunlocked', 'completion'),
218 get_string('completedunlockedtext', 'completion')),
220 $mform->removeElement('unlockcompletion');
221 $mform->getElement('completionunlocked')->setValue(1);
223 // No, add in the warning text with the count (now we know
224 // it) before the unlock button
225 $mform->insertElementBefore(
226 $mform->createElement('static', 'completedwarning',
227 get_string('completedwarning', 'completion'),
228 get_string('completedwarningtext', 'completion', $completedcount)),
235 $mform->freeze('completion');
236 if ($mform->elementExists('completionview')) {
237 $mform->freeze('completionview'); // don't use hardFreeze or checkbox value gets lost
239 if ($mform->elementExists('completionusegrade')) {
240 $mform->freeze('completionusegrade');
242 $mform->freeze($this->_customcompletionelements
);
246 // Availability conditions
247 if (!empty($CFG->enableavailability
) && $this->_cm
) {
248 $ci = new condition_info($this->_cm
);
249 $fullcm=$ci->get_full_course_module();
252 foreach($fullcm->conditionsgrade
as $gradeitemid=>$minmax) {
253 $groupelements=$mform->getElement('conditiongradegroup['.$num.']')->getElements();
254 $groupelements[0]->setValue($gradeitemid);
255 $groupelements[2]->setValue(is_null($minmax->min
) ?
'' :
256 format_float($minmax->min
, 5, true, true));
257 $groupelements[4]->setValue(is_null($minmax->max
) ?
'' :
258 format_float($minmax->max
, 5, true, true));
263 foreach($fullcm->conditionsfield
as $field => $details) {
264 $groupelements = $mform->getElement('conditionfieldgroup['.$num.']')->getElements();
265 $groupelements[0]->setValue($field);
266 $groupelements[1]->setValue(is_null($details->operator
) ?
'' : $details->operator
);
267 $groupelements[2]->setValue(is_null($details->value
) ?
'' : $details->value
);
271 if ($completion->is_enabled()) {
273 foreach($fullcm->conditionscompletion
as $othercmid=>$state) {
274 $groupelements=$mform->getElement('conditioncompletiongroup['.$num.']')->getElements();
275 $groupelements[0]->setValue($othercmid);
276 $groupelements[1]->setValue($state);
284 function validation($data, $files) {
286 $errors = parent
::validation($data, $files);
288 $mform =& $this->_form
;
292 if ($mform->elementExists('name')) {
293 $name = trim($data['name']);
295 $errors['name'] = get_string('required');
299 $grade_item = grade_item
::fetch(array('itemtype'=>'mod', 'itemmodule'=>$data['modulename'],
300 'iteminstance'=>$data['instance'], 'itemnumber'=>0, 'courseid'=>$COURSE->id
));
301 if ($data['coursemodule']) {
302 $cm = $DB->get_record('course_modules', array('id'=>$data['coursemodule']));
307 if ($mform->elementExists('cmidnumber')) {
308 // verify the idnumber
309 if (!grade_verify_idnumber($data['cmidnumber'], $COURSE->id
, $grade_item, $cm)) {
310 $errors['cmidnumber'] = get_string('idnumbertaken');
314 // Completion: Don't let them choose automatic completion without turning
315 // on some conditions
316 if (array_key_exists('completion', $data) && $data['completion']==COMPLETION_TRACKING_AUTOMATIC
) {
317 if (empty($data['completionview']) && empty($data['completionusegrade']) &&
318 !$this->completion_rule_enabled($data)) {
319 $errors['completion'] = get_string('badautocompletion', 'completion');
323 // Conditions: Don't let them set dates which make no sense
324 if (array_key_exists('availablefrom', $data) &&
325 $data['availablefrom'] && $data['availableuntil'] &&
326 $data['availablefrom'] >= $data['availableuntil']) {
327 $errors['availablefrom'] = get_string('badavailabledates', 'condition');
330 // Conditions: Verify that the grade conditions are numbers, and make sense.
331 if (array_key_exists('conditiongradegroup', $data)) {
332 foreach ($data['conditiongradegroup'] as $i => $gradedata) {
333 if ($gradedata['conditiongrademin'] !== '' &&
334 !is_numeric(unformat_float($gradedata['conditiongrademin']))) {
335 $errors["conditiongradegroup[{$i}]"] = get_string('gradesmustbenumeric', 'condition');
338 if ($gradedata['conditiongrademax'] !== '' &&
339 !is_numeric(unformat_float($gradedata['conditiongrademax']))) {
340 $errors["conditiongradegroup[{$i}]"] = get_string('gradesmustbenumeric', 'condition');
343 if ($gradedata['conditiongrademin'] !== '' && $gradedata['conditiongrademax'] !== '' &&
344 unformat_float($gradedata['conditiongrademax']) <= unformat_float($gradedata['conditiongrademin'])) {
345 $errors["conditiongradegroup[{$i}]"] = get_string('badgradelimits', 'condition');
348 if ($gradedata['conditiongrademin'] === '' && $gradedata['conditiongrademax'] === '' &&
349 $gradedata['conditiongradeitemid']) {
350 $errors["conditiongradegroup[{$i}]"] = get_string('gradeitembutnolimits', 'condition');
353 if (($gradedata['conditiongrademin'] !== '' ||
$gradedata['conditiongrademax'] !== '') &&
354 !$gradedata['conditiongradeitemid']) {
355 $errors["conditiongradegroup[{$i}]"] = get_string('gradelimitsbutnoitem', 'condition');
361 // Conditions: Verify that the user profile field has not been declared more than once
362 if (array_key_exists('conditionfieldgroup', $data)) {
363 // Array to store the existing fields
364 $arrcurrentfields = array();
365 // Error message displayed if any condition is declared more than once. We use lang string because
366 // this way we don't actually generate the string unless there is an error.
367 $stralreadydeclaredwarning = new lang_string('fielddeclaredmultipletimes', 'condition');
368 foreach ($data['conditionfieldgroup'] as $i => $fielddata) {
369 if ($fielddata['conditionfield'] == 0) { // Don't need to bother if none is selected
372 if (in_array($fielddata['conditionfield'], $arrcurrentfields)) {
373 $errors["conditionfieldgroup[{$i}]"] = $stralreadydeclaredwarning->out();
375 // Add the field to the array
376 $arrcurrentfields[] = $fielddata['conditionfield'];
384 * Load in existing data as form defaults. Usually new entry defaults are stored directly in
385 * form definition (new entry form); this function is used to load in data where values
386 * already exist and data is being edited (edit entry form).
388 * @param mixed $default_values object or array of default values
390 function set_data($default_values) {
391 if (is_object($default_values)) {
392 $default_values = (array)$default_values;
395 $this->data_preprocessing($default_values);
396 parent
::set_data($default_values);
400 * Adds all the standard elements to a form to edit the settings for an activity module.
402 function standard_coursemodule_elements(){
403 global $COURSE, $CFG, $DB;
404 $mform =& $this->_form
;
406 $this->_outcomesused
= false;
407 if ($this->_features
->outcomes
) {
408 if ($outcomes = grade_outcome
::fetch_all_available($COURSE->id
)) {
409 $this->_outcomesused
= true;
410 $mform->addElement('header', 'modoutcomes', get_string('outcomes', 'grades'));
411 foreach($outcomes as $outcome) {
412 $mform->addElement('advcheckbox', 'outcome_'.$outcome->id
, $outcome->get_name());
418 if ($this->_features
->rating
) {
419 require_once($CFG->dirroot
.'/rating/lib.php');
420 $rm = new rating_manager();
422 $mform->addElement('header', 'modstandardratings', get_string('ratings', 'rating'));
424 $permission=CAP_ALLOW
;
425 $rolenamestring = null;
426 if (!empty($this->_cm
)) {
427 $context = context_module
::instance($this->_cm
->id
);
429 $rolenames = get_role_names_with_caps_in_context($context, array('moodle/rating:rate', 'mod/'.$this->_cm
->modname
.':rate'));
430 $rolenamestring = implode(', ', $rolenames);
432 $rolenamestring = get_string('capabilitychecknotavailable','rating');
434 $mform->addElement('static', 'rolewarning', get_string('rolewarning','rating'), $rolenamestring);
435 $mform->addHelpButton('rolewarning', 'rolewarning', 'rating');
437 $mform->addElement('select', 'assessed', get_string('aggregatetype', 'rating') , $rm->get_aggregate_types());
438 $mform->setDefault('assessed', 0);
439 $mform->addHelpButton('assessed', 'aggregatetype', 'rating');
441 $mform->addElement('modgrade', 'scale', get_string('scale'), false);
442 $mform->disabledIf('scale', 'assessed', 'eq', 0);
444 $mform->addElement('checkbox', 'ratingtime', get_string('ratingtime', 'rating'));
445 $mform->disabledIf('ratingtime', 'assessed', 'eq', 0);
447 $mform->addElement('date_time_selector', 'assesstimestart', get_string('from'));
448 $mform->disabledIf('assesstimestart', 'assessed', 'eq', 0);
449 $mform->disabledIf('assesstimestart', 'ratingtime');
451 $mform->addElement('date_time_selector', 'assesstimefinish', get_string('to'));
452 $mform->disabledIf('assesstimefinish', 'assessed', 'eq', 0);
453 $mform->disabledIf('assesstimefinish', 'ratingtime');
456 //doing this here means splitting up the grade related settings on the lesson settings page
457 //$this->standard_grading_coursemodule_elements();
459 $mform->addElement('header', 'modstandardelshdr', get_string('modstandardels', 'form'));
461 $mform->addElement('modvisible', 'visible', get_string('visible'));
462 if (!empty($this->_cm
)) {
463 $context = context_module
::instance($this->_cm
->id
);
464 if (!has_capability('moodle/course:activityvisibility', $context)) {
465 $mform->hardFreeze('visible');
469 if ($this->_features
->idnumber
) {
470 $mform->addElement('text', 'cmidnumber', get_string('idnumbermod'));
471 $mform->setType('cmidnumber', PARAM_RAW
);
472 $mform->addHelpButton('cmidnumber', 'idnumbermod');
475 if ($this->_features
->groups
) {
476 $options = array(NOGROUPS
=> get_string('groupsnone'),
477 SEPARATEGROUPS
=> get_string('groupsseparate'),
478 VISIBLEGROUPS
=> get_string('groupsvisible'));
479 $mform->addElement('select', 'groupmode', get_string('groupmode', 'group'), $options, NOGROUPS
);
480 $mform->addHelpButton('groupmode', 'groupmode', 'group');
483 if ($this->_features
->groupings
or $this->_features
->groupmembersonly
) {
484 //groupings selector - used for normal grouping mode or also when restricting access with groupmembersonly
486 $options[0] = get_string('none');
487 if ($groupings = $DB->get_records('groupings', array('courseid'=>$COURSE->id
))) {
488 foreach ($groupings as $grouping) {
489 $options[$grouping->id
] = format_string($grouping->name
);
492 $mform->addElement('select', 'groupingid', get_string('grouping', 'group'), $options);
493 $mform->addHelpButton('groupingid', 'grouping', 'group');
496 if ($this->_features
->groupmembersonly
) {
497 $mform->addElement('checkbox', 'groupmembersonly', get_string('groupmembersonly', 'group'));
498 $mform->addHelpButton('groupmembersonly', 'groupmembersonly', 'group');
501 if (!empty($CFG->enableavailability
)) {
502 // String used by conditions
503 $strnone = get_string('none','condition');
504 // Conditional availability
506 // Available from/to defaults to midnight because then the display
507 // will be nicer where it tells users when they can access it (it
508 // shows only the date and not time).
509 $date = usergetdate(time());
510 $midnight = make_timestamp($date['year'], $date['mon'], $date['mday']);
512 // From/until controls
513 $mform->addElement('header', 'availabilityconditionsheader',
514 get_string('availabilityconditions', 'condition'));
515 $mform->addElement('date_time_selector', 'availablefrom',
516 get_string('availablefrom', 'condition'),
517 array('optional' => true, 'defaulttime' => $midnight));
518 $mform->addHelpButton('availablefrom', 'availablefrom', 'condition');
519 $mform->addElement('date_time_selector', 'availableuntil',
520 get_string('availableuntil', 'condition'),
521 array('optional' => true, 'defaulttime' => $midnight));
523 // Conditions based on grades
524 $gradeoptions = array();
525 $items = grade_item
::fetch_all(array('courseid'=>$COURSE->id
));
526 $items = $items ?
$items : array();
527 foreach($items as $id=>$item) {
528 // Do not include grades for current item
529 if (!empty($this->_cm
) && $this->_cm
->instance
== $item->iteminstance
530 && $this->_cm
->modname
== $item->itemmodule
531 && $item->itemtype
== 'mod') {
534 $gradeoptions[$id] = $item->get_name();
536 asort($gradeoptions);
537 $gradeoptions = array(0 => $strnone) +
$gradeoptions;
539 $grouparray = array();
540 $grouparray[] =& $mform->createElement('select','conditiongradeitemid','',$gradeoptions);
541 $grouparray[] =& $mform->createElement('static', '', '',' '.get_string('grade_atleast','condition').' ');
542 $grouparray[] =& $mform->createElement('text', 'conditiongrademin','',array('size'=>3));
543 $grouparray[] =& $mform->createElement('static', '', '','% '.get_string('grade_upto','condition').' ');
544 $grouparray[] =& $mform->createElement('text', 'conditiongrademax','',array('size'=>3));
545 $grouparray[] =& $mform->createElement('static', '', '','%');
546 $group = $mform->createElement('group','conditiongradegroup',
547 get_string('gradecondition', 'condition'),$grouparray);
549 // Get version with condition info and store it so we don't ask
551 if(!empty($this->_cm
)) {
552 $ci = new condition_info($this->_cm
, CONDITION_MISSING_EXTRATABLE
);
553 $this->_cm
= $ci->get_full_course_module();
554 $count = count($this->_cm
->conditionsgrade
)+
1;
555 $fieldcount = count($this->_cm
->conditionsfield
) +
1;
561 $this->repeat_elements(array($group), $count, array(), 'conditiongraderepeats', 'conditiongradeadds', 2,
562 get_string('addgrades', 'condition'), true);
563 $mform->addHelpButton('conditiongradegroup[0]', 'gradecondition', 'condition');
565 // Conditions based on user fields
566 $operators = condition_info
::get_condition_user_field_operators();
567 $useroptions = condition_info
::get_condition_user_fields(
568 array('context' => $this->context
));
571 $useroptions = array(0 => $strnone) +
$useroptions;
572 $grouparray = array();
573 $grouparray[] =& $mform->createElement('select', 'conditionfield', '', $useroptions);
574 $grouparray[] =& $mform->createElement('select', 'conditionfieldoperator', '', $operators);
575 $grouparray[] =& $mform->createElement('text', 'conditionfieldvalue');
576 $mform->setType('conditionfieldvalue', PARAM_RAW
);
577 $group = $mform->createElement('group', 'conditionfieldgroup', get_string('userfield', 'condition'), $grouparray);
579 $this->repeat_elements(array($group), $fieldcount, array(), 'conditionfieldrepeats', 'conditionfieldadds', 2,
580 get_string('adduserfields', 'condition'), true);
581 $mform->addHelpButton('conditionfieldgroup[0]', 'userfield', 'condition');
583 // Conditions based on completion
584 $completion = new completion_info($COURSE);
585 if ($completion->is_enabled()) {
586 $completionoptions = array();
587 $modinfo = get_fast_modinfo($COURSE);
588 foreach($modinfo->cms
as $id=>$cm) {
589 // Add each course-module if it:
590 // (a) has completion turned on
591 // (b) is not the same as current course-module
592 if ($cm->completion
&& (empty($this->_cm
) ||
$this->_cm
->id
!= $id)) {
593 $completionoptions[$id]=$cm->name
;
596 asort($completionoptions);
597 $completionoptions = array(0 => $strnone) +
$completionoptions;
599 $completionvalues=array(
600 COMPLETION_COMPLETE
=>get_string('completion_complete','condition'),
601 COMPLETION_INCOMPLETE
=>get_string('completion_incomplete','condition'),
602 COMPLETION_COMPLETE_PASS
=>get_string('completion_pass','condition'),
603 COMPLETION_COMPLETE_FAIL
=>get_string('completion_fail','condition'));
605 $grouparray = array();
606 $grouparray[] =& $mform->createElement('select','conditionsourcecmid','',$completionoptions);
607 $grouparray[] =& $mform->createElement('select','conditionrequiredcompletion','',$completionvalues);
608 $group = $mform->createElement('group','conditioncompletiongroup',
609 get_string('completioncondition', 'condition'),$grouparray);
611 $count = empty($this->_cm
) ?
1 : count($this->_cm
->conditionscompletion
)+
1;
612 $this->repeat_elements(array($group),$count,array(),
613 'conditioncompletionrepeats','conditioncompletionadds',2,
614 get_string('addcompletions','condition'),true);
615 $mform->addHelpButton('conditioncompletiongroup[0]', 'completioncondition', 'condition');
618 // Do we display availability info to students?
619 $mform->addElement('select', 'showavailability', get_string('showavailability', 'condition'),
620 array(CONDITION_STUDENTVIEW_SHOW
=>get_string('showavailability_show', 'condition'),
621 CONDITION_STUDENTVIEW_HIDE
=>get_string('showavailability_hide', 'condition')));
622 $mform->setDefault('showavailability', CONDITION_STUDENTVIEW_SHOW
);
625 // Conditional activities: completion tracking section
626 if(!isset($completion)) {
627 $completion = new completion_info($COURSE);
629 if ($completion->is_enabled()) {
630 $mform->addElement('header', 'activitycompletionheader', get_string('activitycompletion', 'completion'));
632 // Unlock button for if people have completed it (will
633 // be removed in definition_after_data if they haven't)
634 $mform->addElement('submit', 'unlockcompletion', get_string('unlockcompletion', 'completion'));
635 $mform->registerNoSubmitButton('unlockcompletion');
636 $mform->addElement('hidden', 'completionunlocked', 0);
637 $mform->setType('completionunlocked', PARAM_INT
);
639 $mform->addElement('select', 'completion', get_string('completion', 'completion'),
640 array(COMPLETION_TRACKING_NONE
=>get_string('completion_none', 'completion'),
641 COMPLETION_TRACKING_MANUAL
=>get_string('completion_manual', 'completion')));
642 $mform->setDefault('completion', $this->_features
->defaultcompletion
643 ? COMPLETION_TRACKING_MANUAL
644 : COMPLETION_TRACKING_NONE
);
645 $mform->addHelpButton('completion', 'completion', 'completion');
647 // Automatic completion once you view it
648 $gotcompletionoptions = false;
649 if (plugin_supports('mod', $this->_modname
, FEATURE_COMPLETION_TRACKS_VIEWS
, false)) {
650 $mform->addElement('checkbox', 'completionview', get_string('completionview', 'completion'),
651 get_string('completionview_desc', 'completion'));
652 $mform->disabledIf('completionview', 'completion', 'ne', COMPLETION_TRACKING_AUTOMATIC
);
653 $gotcompletionoptions = true;
656 // Automatic completion once it's graded
657 if (plugin_supports('mod', $this->_modname
, FEATURE_GRADE_HAS_GRADE
, false)) {
658 $mform->addElement('checkbox', 'completionusegrade', get_string('completionusegrade', 'completion'),
659 get_string('completionusegrade_desc', 'completion'));
660 $mform->disabledIf('completionusegrade', 'completion', 'ne', COMPLETION_TRACKING_AUTOMATIC
);
661 $mform->addHelpButton('completionusegrade', 'completionusegrade', 'completion');
662 $gotcompletionoptions = true;
665 // Automatic completion according to module-specific rules
666 $this->_customcompletionelements
= $this->add_completion_rules();
667 foreach ($this->_customcompletionelements
as $element) {
668 $mform->disabledIf($element, 'completion', 'ne', COMPLETION_TRACKING_AUTOMATIC
);
671 $gotcompletionoptions = $gotcompletionoptions ||
672 count($this->_customcompletionelements
)>0;
674 // Automatic option only appears if possible
675 if ($gotcompletionoptions) {
676 $mform->getElement('completion')->addOption(
677 get_string('completion_automatic', 'completion'),
678 COMPLETION_TRACKING_AUTOMATIC
);
681 // Completion expected at particular date? (For progress tracking)
682 $mform->addElement('date_selector', 'completionexpected', get_string('completionexpected', 'completion'), array('optional'=>true));
683 $mform->addHelpButton('completionexpected', 'completionexpected', 'completion');
684 $mform->disabledIf('completionexpected', 'completion', 'eq', COMPLETION_TRACKING_NONE
);
687 $this->standard_hidden_coursemodule_elements();
691 * Can be overridden to add custom completion rules if the module wishes
692 * them. If overriding this, you should also override completion_rule_enabled.
694 * Just add elements to the form as needed and return the list of IDs. The
695 * system will call disabledIf and handle other behaviour for each returned
697 * @return array Array of string IDs of added items, empty array if none
699 function add_completion_rules() {
704 * Called during validation. Override to indicate, based on the data, whether
705 * a custom completion rule is enabled (selected).
707 * @param array $data Input data (not yet validated)
708 * @return bool True if one or more rules is enabled, false if none are;
709 * default returns false
711 function completion_rule_enabled($data) {
715 function standard_hidden_coursemodule_elements(){
716 $mform =& $this->_form
;
717 $mform->addElement('hidden', 'course', 0);
718 $mform->setType('course', PARAM_INT
);
720 $mform->addElement('hidden', 'coursemodule', 0);
721 $mform->setType('coursemodule', PARAM_INT
);
723 $mform->addElement('hidden', 'section', 0);
724 $mform->setType('section', PARAM_INT
);
726 $mform->addElement('hidden', 'module', 0);
727 $mform->setType('module', PARAM_INT
);
729 $mform->addElement('hidden', 'modulename', '');
730 $mform->setType('modulename', PARAM_PLUGIN
);
732 $mform->addElement('hidden', 'instance', 0);
733 $mform->setType('instance', PARAM_INT
);
735 $mform->addElement('hidden', 'add', 0);
736 $mform->setType('add', PARAM_ALPHA
);
738 $mform->addElement('hidden', 'update', 0);
739 $mform->setType('update', PARAM_INT
);
741 $mform->addElement('hidden', 'return', 0);
742 $mform->setType('return', PARAM_BOOL
);
744 $mform->addElement('hidden', 'sr', 0);
745 $mform->setType('sr', PARAM_INT
);
748 public function standard_grading_coursemodule_elements() {
749 global $COURSE, $CFG;
750 $mform =& $this->_form
;
752 if ($this->_features
->hasgrades
) {
754 if (!$this->_features
->rating ||
$this->_features
->gradecat
) {
755 $mform->addElement('header', 'modstandardgrade', get_string('grade'));
758 //if supports grades and grades arent being handled via ratings
759 if (!$this->_features
->rating
) {
760 $mform->addElement('modgrade', 'grade', get_string('grade'));
761 $mform->setDefault('grade', 100);
764 if ($this->_features
->advancedgrading
765 and !empty($this->current
->_advancedgradingdata
['methods'])
766 and !empty($this->current
->_advancedgradingdata
['areas'])) {
768 if (count($this->current
->_advancedgradingdata
['areas']) == 1) {
769 // if there is just one gradable area (most cases), display just the selector
770 // without its name to make UI simplier
771 $areadata = reset($this->current
->_advancedgradingdata
['areas']);
772 $areaname = key($this->current
->_advancedgradingdata
['areas']);
773 $mform->addElement('select', 'advancedgradingmethod_'.$areaname,
774 get_string('gradingmethod', 'core_grading'), $this->current
->_advancedgradingdata
['methods']);
775 $mform->addHelpButton('advancedgradingmethod_'.$areaname, 'gradingmethod', 'core_grading');
778 // the module defines multiple gradable areas, display a selector
779 // for each of them together with a name of the area
780 $areasgroup = array();
781 foreach ($this->current
->_advancedgradingdata
['areas'] as $areaname => $areadata) {
782 $areasgroup[] = $mform->createElement('select', 'advancedgradingmethod_'.$areaname,
783 $areadata['title'], $this->current
->_advancedgradingdata
['methods']);
784 $areasgroup[] = $mform->createElement('static', 'advancedgradingareaname_'.$areaname, '', $areadata['title']);
786 $mform->addGroup($areasgroup, 'advancedgradingmethodsgroup', get_string('gradingmethods', 'core_grading'),
787 array(' ', '<br />'), false);
791 if ($this->_features
->gradecat
) {
792 $mform->addElement('select', 'gradecat',
793 get_string('gradecategoryonmodform', 'grades'),
794 grade_get_categories_menu($COURSE->id
, $this->_outcomesused
));
795 $mform->addHelpButton('gradecat', 'gradecategoryonmodform', 'grades');
800 function add_intro_editor($required=false, $customlabel=null) {
801 if (!$this->_features
->introeditor
) {
802 // intro editor not supported in this module
806 $mform = $this->_form
;
807 $label = is_null($customlabel) ?
get_string('moduleintro') : $customlabel;
809 $mform->addElement('editor', 'introeditor', $label, null, array('maxfiles'=>EDITOR_UNLIMITED_FILES
, 'noclean'=>true, 'context'=>$this->context
));
810 $mform->setType('introeditor', PARAM_RAW
); // no XSS prevention here, users must be trusted
812 $mform->addRule('introeditor', get_string('required'), 'required', null, 'client');
815 // If the 'show description' feature is enabled, this checkbox appears
817 if ($this->_features
->showdescription
) {
818 $mform->addElement('checkbox', 'showdescription', get_string('showdescription'));
819 $mform->addHelpButton('showdescription', 'showdescription');
824 * Overriding formslib's add_action_buttons() method, to add an extra submit "save changes and return" button.
826 * @param bool $cancel show cancel button
827 * @param string $submitlabel null means default, false means none, string is label text
828 * @param string $submit2label null means default, false means none, string is label text
831 function add_action_buttons($cancel=true, $submitlabel=null, $submit2label=null) {
832 if (is_null($submitlabel)) {
833 $submitlabel = get_string('savechangesanddisplay');
836 if (is_null($submit2label)) {
837 $submit2label = get_string('savechangesandreturntocourse');
840 $mform = $this->_form
;
842 // elements in a row need a group
843 $buttonarray = array();
845 if ($submit2label !== false) {
846 $buttonarray[] = &$mform->createElement('submit', 'submitbutton2', $submit2label);
849 if ($submitlabel !== false) {
850 $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submitlabel);
854 $buttonarray[] = &$mform->createElement('cancel');
857 $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
858 $mform->setType('buttonar', PARAM_RAW
);
859 $mform->closeHeaderBefore('buttonar');