Merge branch 'MDL-36412-m23' of git://github.com/sammarshallou/moodle into MOODLE_23_...
[moodle.git] / course / moodleform_mod.php
1 <?php
2 require_once ($CFG->libdir.'/formslib.php');
3 require_once($CFG->libdir.'/completionlib.php');
5 /**
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
8  */
9 abstract class moodleform_mod extends moodleform {
10     /** Current data */
11     protected $current;
12     /**
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
15      * update one.
16      *
17      * @var mixed
18      */
19     protected $_instance;
20     /**
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).
23      *
24      * @var mixed
25      */
26     protected $_section;
27     /**
28      * Course module record of the module that is being updated. Will be null if this is an 'add' form and not an
29      * update one.
30       *
31      * @var mixed
32      */
33     protected $_cm;
34     /**
35      * List of modform features
36      */
37     protected $_features;
38     /**
39      * @var array Custom completion-rule elements, if enabled
40      */
41     protected $_customcompletionelements;
42     /**
43      * @var string name of module
44      */
45     protected $_modname;
46     /** current context, course or module depends if already exists*/
47     protected $context;
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;
56         $this->_cm       = $cm;
57         if ($this->_cm) {
58             $this->context = get_context_instance(CONTEXT_MODULE, $this->_cm->id);
59         } else {
60             $this->context = get_context_instance(CONTEXT_COURSE, $course->id);
61         }
63         // Guess module name
64         $matches = array();
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');
68         }
69         $this->_modname = $matches[1];
70         $this->init_features();
71         parent::moodleform('modedit.php');
72     }
74     protected function init_features() {
75         global $CFG;
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);
91     }
93     /**
94      * Only available on moodleform_mod.
95      *
96      * @param array $default_values passed by reference
97      */
98     function data_preprocessing(&$default_values){
99         if (empty($default_values['scale'])) {
100             $default_values['assessed'] = 0;
101         }
103         if (empty($default_values['assessed'])){
104             $default_values['ratingtime'] = 0;
105         } else {
106             $default_values['ratingtime']=
107                 ($default_values['assesstimestart'] && $default_values['assesstimefinish']) ? 1 : 0;
108         }
109     }
111     /**
112      * Each module which defines definition_after_data() must call this method using parent::definition_after_data();
113      */
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) {
123                 $gradecat = false;
124                 if (!empty($CFG->enableoutcomes) and $this->_features->outcomes) {
125                     $outcomes = grade_outcome::fetch_all_available($COURSE->id);
126                     if (!empty($outcomes)) {
127                         $gradecat = true;
128                     }
129                 }
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
139                             }
140                         }
141                     }
143                     foreach ($items as $item) {
144                         if (is_bool($gradecat)) {
145                             $gradecat = $item->categoryid;
146                             continue;
147                         }
148                         if ($gradecat != $item->categoryid) {
149                             //mixed categories
150                             $gradecat = false;
151                             break;
152                         }
153                     }
154                 }
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');
164                         }
165                     }
166                 }
167             }
168         }
170         if ($COURSE->groupmodeforce) {
171             if ($mform->elementExists('groupmode')) {
172                 $mform->hardFreeze('groupmode'); // groupmode can not be changed if forced from course settings
173             }
174         }
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');
190                 }
191             }
192         }
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)
199                 ? 0
200                 : $completion->count_user_data($this->_cm);
202             $freeze = false;
203             if (!$completedcount) {
204                 if ($mform->elementExists('unlockcompletion')) {
205                     $mform->removeElement('unlockcompletion');
206                 }
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);
211             } else {
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')),
219                         'unlockcompletion');
220                     $mform->removeElement('unlockcompletion');
221                     $mform->getElement('completionunlocked')->setValue(1);
222                 } else {
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)),
229                         'unlockcompletion');
230                     $freeze = true;
231                 }
232             }
234             if ($freeze) {
235                 $mform->freeze('completion');
236                 if ($mform->elementExists('completionview')) {
237                     $mform->freeze('completionview'); // don't use hardFreeze or checkbox value gets lost
238                 }
239                 if ($mform->elementExists('completionusegrade')) {
240                     $mform->freeze('completionusegrade');
241                 }
242                 $mform->freeze($this->_customcompletionelements);
243             }
244         }
246         // Availability conditions
247         if (!empty($CFG->enableavailability) && $this->_cm) {
248             $ci = new condition_info($this->_cm);
249             $fullcm=$ci->get_full_course_module();
251             $num=0;
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));
259                 $num++;
260             }
262             if ($completion->is_enabled()) {
263                 $num=0;
264                 foreach($fullcm->conditionscompletion as $othercmid=>$state) {
265                     $groupelements=$mform->getElement('conditioncompletiongroup['.$num.']')->getElements();
266                     $groupelements[0]->setValue($othercmid);
267                     $groupelements[1]->setValue($state);
268                     $num++;
269                 }
270             }
271         }
272     }
274     // form verification
275     function validation($data, $files) {
276         global $COURSE, $DB;
277         $errors = parent::validation($data, $files);
279         $mform =& $this->_form;
281         $errors = array();
283         if ($mform->elementExists('name')) {
284             $name = trim($data['name']);
285             if ($name == '') {
286                 $errors['name'] = get_string('required');
287             }
288         }
290         $grade_item = grade_item::fetch(array('itemtype'=>'mod', 'itemmodule'=>$data['modulename'],
291                      'iteminstance'=>$data['instance'], 'itemnumber'=>0, 'courseid'=>$COURSE->id));
292         if ($data['coursemodule']) {
293             $cm = $DB->get_record('course_modules', array('id'=>$data['coursemodule']));
294         } else {
295             $cm = null;
296         }
298         if ($mform->elementExists('cmidnumber')) {
299             // verify the idnumber
300             if (!grade_verify_idnumber($data['cmidnumber'], $COURSE->id, $grade_item, $cm)) {
301                 $errors['cmidnumber'] = get_string('idnumbertaken');
302             }
303         }
305         // Completion: Don't let them choose automatic completion without turning
306         // on some conditions
307         if (array_key_exists('completion', $data) && $data['completion']==COMPLETION_TRACKING_AUTOMATIC) {
308             if (empty($data['completionview']) && empty($data['completionusegrade']) &&
309                 !$this->completion_rule_enabled($data)) {
310                 $errors['completion'] = get_string('badautocompletion', 'completion');
311             }
312         }
314         // Conditions: Don't let them set dates which make no sense
315         if (array_key_exists('availablefrom', $data) &&
316             $data['availablefrom'] && $data['availableuntil'] &&
317             $data['availablefrom'] >= $data['availableuntil']) {
318             $errors['availablefrom'] = get_string('badavailabledates', 'condition');
319         }
321         // Conditions: Verify that the grade conditions are numbers, and make sense.
322         if (array_key_exists('conditiongradegroup', $data)) {
323             foreach ($data['conditiongradegroup'] as $i => $gradedata) {
324                 if ($gradedata['conditiongrademin'] !== '' &&
325                         !is_numeric(unformat_float($gradedata['conditiongrademin']))) {
326                     $errors["conditiongradegroup[{$i}]"] = get_string('gradesmustbenumeric', 'condition');
327                     continue;
328                 }
329                 if ($gradedata['conditiongrademax'] !== '' &&
330                         !is_numeric(unformat_float($gradedata['conditiongrademax']))) {
331                     $errors["conditiongradegroup[{$i}]"] = get_string('gradesmustbenumeric', 'condition');
332                     continue;
333                 }
334                 if ($gradedata['conditiongrademin'] !== '' && $gradedata['conditiongrademax'] !== '' &&
335                         unformat_float($gradedata['conditiongrademax']) <= unformat_float($gradedata['conditiongrademin'])) {
336                     $errors["conditiongradegroup[{$i}]"] = get_string('badgradelimits', 'condition');
337                     continue;
338                 }
339                 if ($gradedata['conditiongrademin'] === '' && $gradedata['conditiongrademax'] === '' &&
340                         $gradedata['conditiongradeitemid']) {
341                     $errors["conditiongradegroup[{$i}]"] = get_string('gradeitembutnolimits', 'condition');
342                     continue;
343                 }
344                 if (($gradedata['conditiongrademin'] !== '' || $gradedata['conditiongrademax'] !== '') &&
345                         !$gradedata['conditiongradeitemid']) {
346                     $errors["conditiongradegroup[{$i}]"] = get_string('gradelimitsbutnoitem', 'condition');
347                     continue;
348                 }
349             }
350         }
352         return $errors;
353     }
355     /**
356      * Load in existing data as form defaults. Usually new entry defaults are stored directly in
357      * form definition (new entry form); this function is used to load in data where values
358      * already exist and data is being edited (edit entry form).
359      *
360      * @param mixed $default_values object or array of default values
361      */
362     function set_data($default_values) {
363         if (is_object($default_values)) {
364             $default_values = (array)$default_values;
365         }
367         $this->data_preprocessing($default_values);
368         parent::set_data($default_values);
369     }
371     /**
372      * Adds all the standard elements to a form to edit the settings for an activity module.
373      */
374     function standard_coursemodule_elements(){
375         global $COURSE, $CFG, $DB;
376         $mform =& $this->_form;
378         $this->_outcomesused = false;
379         if ($this->_features->outcomes) {
380             if ($outcomes = grade_outcome::fetch_all_available($COURSE->id)) {
381                 $this->_outcomesused = true;
382                 $mform->addElement('header', 'modoutcomes', get_string('outcomes', 'grades'));
383                 foreach($outcomes as $outcome) {
384                     $mform->addElement('advcheckbox', 'outcome_'.$outcome->id, $outcome->get_name());
385                 }
386             }
387         }
390         if ($this->_features->rating) {
391             require_once($CFG->dirroot.'/rating/lib.php');
392             $rm = new rating_manager();
394             $mform->addElement('header', 'modstandardratings', get_string('ratings', 'rating'));
396             $permission=CAP_ALLOW;
397             $rolenamestring = null;
398             if (!empty($this->_cm)) {
399                 $context = get_context_instance(CONTEXT_MODULE, $this->_cm->id);
401                 $rolenames = get_role_names_with_caps_in_context($context, array('moodle/rating:rate', 'mod/'.$this->_cm->modname.':rate'));
402                 $rolenamestring = implode(', ', $rolenames);
403             } else {
404                 $rolenamestring = get_string('capabilitychecknotavailable','rating');
405             }
406             $mform->addElement('static', 'rolewarning', get_string('rolewarning','rating'), $rolenamestring);
407             $mform->addHelpButton('rolewarning', 'rolewarning', 'rating');
409             $mform->addElement('select', 'assessed', get_string('aggregatetype', 'rating') , $rm->get_aggregate_types());
410             $mform->setDefault('assessed', 0);
411             $mform->addHelpButton('assessed', 'aggregatetype', 'rating');
413             $mform->addElement('modgrade', 'scale', get_string('scale'), false);
414             $mform->disabledIf('scale', 'assessed', 'eq', 0);
416             $mform->addElement('checkbox', 'ratingtime', get_string('ratingtime', 'rating'));
417             $mform->disabledIf('ratingtime', 'assessed', 'eq', 0);
419             $mform->addElement('date_time_selector', 'assesstimestart', get_string('from'));
420             $mform->disabledIf('assesstimestart', 'assessed', 'eq', 0);
421             $mform->disabledIf('assesstimestart', 'ratingtime');
423             $mform->addElement('date_time_selector', 'assesstimefinish', get_string('to'));
424             $mform->disabledIf('assesstimefinish', 'assessed', 'eq', 0);
425             $mform->disabledIf('assesstimefinish', 'ratingtime');
426         }
428         //doing this here means splitting up the grade related settings on the lesson settings page
429         //$this->standard_grading_coursemodule_elements();
431         $mform->addElement('header', 'modstandardelshdr', get_string('modstandardels', 'form'));
432         if ($this->_features->groups) {
433             $options = array(NOGROUPS       => get_string('groupsnone'),
434                              SEPARATEGROUPS => get_string('groupsseparate'),
435                              VISIBLEGROUPS  => get_string('groupsvisible'));
436             $mform->addElement('select', 'groupmode', get_string('groupmode', 'group'), $options, NOGROUPS);
437             $mform->addHelpButton('groupmode', 'groupmode', 'group');
438         }
440         if ($this->_features->groupings or $this->_features->groupmembersonly) {
441             //groupings selector - used for normal grouping mode or also when restricting access with groupmembersonly
442             $options = array();
443             $options[0] = get_string('none');
444             if ($groupings = $DB->get_records('groupings', array('courseid'=>$COURSE->id))) {
445                 foreach ($groupings as $grouping) {
446                     $options[$grouping->id] = format_string($grouping->name);
447                 }
448             }
449             $mform->addElement('select', 'groupingid', get_string('grouping', 'group'), $options);
450             $mform->addHelpButton('groupingid', 'grouping', 'group');
451             $mform->setAdvanced('groupingid');
452         }
454         if ($this->_features->groupmembersonly) {
455             $mform->addElement('checkbox', 'groupmembersonly', get_string('groupmembersonly', 'group'));
456             $mform->addHelpButton('groupmembersonly', 'groupmembersonly', 'group');
457             $mform->setAdvanced('groupmembersonly');
458         }
460         $mform->addElement('modvisible', 'visible', get_string('visible'));
461         if (!empty($this->_cm)) {
462             $context = get_context_instance(CONTEXT_MODULE, $this->_cm->id);
463             if (!has_capability('moodle/course:activityvisibility', $context)) {
464                 $mform->hardFreeze('visible');
465             }
466         }
468         if ($this->_features->idnumber) {
469             $mform->addElement('text', 'cmidnumber', get_string('idnumbermod'));
470             $mform->addHelpButton('cmidnumber', 'idnumbermod');
471         }
473         if (!empty($CFG->enableavailability)) {
474             // Conditional availability
476             // Available from/to defaults to midnight because then the display
477             // will be nicer where it tells users when they can access it (it
478             // shows only the date and not time).
479             $date = usergetdate(time());
480             $midnight = make_timestamp($date['year'], $date['mon'], $date['mday']);
482             // From/until controls
483             $mform->addElement('header', 'availabilityconditionsheader',
484                     get_string('availabilityconditions', 'condition'));
485             $mform->addElement('date_time_selector', 'availablefrom',
486                     get_string('availablefrom', 'condition'),
487                     array('optional' => true, 'defaulttime' => $midnight));
488             $mform->addHelpButton('availablefrom', 'availablefrom', 'condition');
489             $mform->addElement('date_time_selector', 'availableuntil',
490                     get_string('availableuntil', 'condition'),
491                     array('optional' => true, 'defaulttime' => $midnight));
493             // Conditions based on grades
494             $gradeoptions = array();
495             $items = grade_item::fetch_all(array('courseid'=>$COURSE->id));
496             $items = $items ? $items : array();
497             foreach($items as $id=>$item) {
498                 // Do not include grades for current item
499                 if (!empty($this->_cm) && $this->_cm->instance == $item->iteminstance
500                     && $this->_cm->modname == $item->itemmodule
501                     && $item->itemtype == 'mod') {
502                     continue;
503                 }
504                 $gradeoptions[$id] = $item->get_name();
505             }
506             asort($gradeoptions);
507             $gradeoptions = array(0=>get_string('none','condition'))+$gradeoptions;
509             $grouparray = array();
510             $grouparray[] =& $mform->createElement('select','conditiongradeitemid','',$gradeoptions);
511             $grouparray[] =& $mform->createElement('static', '', '',' '.get_string('grade_atleast','condition').' ');
512             $grouparray[] =& $mform->createElement('text', 'conditiongrademin','',array('size'=>3));
513             $grouparray[] =& $mform->createElement('static', '', '','% '.get_string('grade_upto','condition').' ');
514             $grouparray[] =& $mform->createElement('text', 'conditiongrademax','',array('size'=>3));
515             $grouparray[] =& $mform->createElement('static', '', '','%');
516             $group = $mform->createElement('group','conditiongradegroup',
517                 get_string('gradecondition', 'condition'),$grouparray);
519             // Get version with condition info and store it so we don't ask
520             // twice
521             if(!empty($this->_cm)) {
522                 $ci = new condition_info($this->_cm, CONDITION_MISSING_EXTRATABLE);
523                 $this->_cm = $ci->get_full_course_module();
524                 $count = count($this->_cm->conditionsgrade)+1;
525             } else {
526                 $count = 1;
527             }
529             $this->repeat_elements(array($group), $count, array(), 'conditiongraderepeats', 'conditiongradeadds', 2,
530                                    get_string('addgrades', 'condition'), true);
531             $mform->addHelpButton('conditiongradegroup[0]', 'gradecondition', 'condition');
533             // Conditions based on completion
534             $completion = new completion_info($COURSE);
535             if ($completion->is_enabled()) {
536                 $completionoptions = array();
537                 $modinfo = get_fast_modinfo($COURSE);
538                 foreach($modinfo->cms as $id=>$cm) {
539                     // Add each course-module if it:
540                     // (a) has completion turned on
541                     // (b) is not the same as current course-module
542                     if ($cm->completion && (empty($this->_cm) || $this->_cm->id != $id)) {
543                         $completionoptions[$id]=$cm->name;
544                     }
545                 }
546                 asort($completionoptions);
547                 $completionoptions = array(0=>get_string('none','condition'))+$completionoptions;
549                 $completionvalues=array(
550                     COMPLETION_COMPLETE=>get_string('completion_complete','condition'),
551                     COMPLETION_INCOMPLETE=>get_string('completion_incomplete','condition'),
552                     COMPLETION_COMPLETE_PASS=>get_string('completion_pass','condition'),
553                     COMPLETION_COMPLETE_FAIL=>get_string('completion_fail','condition'));
555                 $grouparray = array();
556                 $grouparray[] =& $mform->createElement('select','conditionsourcecmid','',$completionoptions);
557                 $grouparray[] =& $mform->createElement('select','conditionrequiredcompletion','',$completionvalues);
558                 $group = $mform->createElement('group','conditioncompletiongroup',
559                     get_string('completioncondition', 'condition'),$grouparray);
561                 $count = empty($this->_cm) ? 1 : count($this->_cm->conditionscompletion)+1;
562                 $this->repeat_elements(array($group),$count,array(),
563                     'conditioncompletionrepeats','conditioncompletionadds',2,
564                     get_string('addcompletions','condition'),true);
565                 $mform->addHelpButton('conditioncompletiongroup[0]', 'completioncondition', 'condition');
566             }
568             // Do we display availability info to students?
569             $mform->addElement('select', 'showavailability', get_string('showavailability', 'condition'),
570                     array(CONDITION_STUDENTVIEW_SHOW=>get_string('showavailability_show', 'condition'),
571                     CONDITION_STUDENTVIEW_HIDE=>get_string('showavailability_hide', 'condition')));
572             $mform->setDefault('showavailability', CONDITION_STUDENTVIEW_SHOW);
573         }
575         // Conditional activities: completion tracking section
576         if(!isset($completion)) {
577             $completion = new completion_info($COURSE);
578         }
579         if ($completion->is_enabled()) {
580             $mform->addElement('header', 'activitycompletionheader', get_string('activitycompletion', 'completion'));
582             // Unlock button for if people have completed it (will
583             // be removed in definition_after_data if they haven't)
584             $mform->addElement('submit', 'unlockcompletion', get_string('unlockcompletion', 'completion'));
585             $mform->registerNoSubmitButton('unlockcompletion');
586             $mform->addElement('hidden', 'completionunlocked', 0);
587             $mform->setType('completionunlocked', PARAM_INT);
589             $mform->addElement('select', 'completion', get_string('completion', 'completion'),
590                 array(COMPLETION_TRACKING_NONE=>get_string('completion_none', 'completion'),
591                 COMPLETION_TRACKING_MANUAL=>get_string('completion_manual', 'completion')));
592             $mform->setDefault('completion', $this->_features->defaultcompletion
593                 ? COMPLETION_TRACKING_MANUAL
594                 : COMPLETION_TRACKING_NONE);
595             $mform->addHelpButton('completion', 'completion', 'completion');
597             // Automatic completion once you view it
598             $gotcompletionoptions = false;
599             if (plugin_supports('mod', $this->_modname, FEATURE_COMPLETION_TRACKS_VIEWS, false)) {
600                 $mform->addElement('checkbox', 'completionview', get_string('completionview', 'completion'),
601                     get_string('completionview_desc', 'completion'));
602                 $mform->disabledIf('completionview', 'completion', 'ne', COMPLETION_TRACKING_AUTOMATIC);
603                 $gotcompletionoptions = true;
604             }
606             // Automatic completion once it's graded
607             if (plugin_supports('mod', $this->_modname, FEATURE_GRADE_HAS_GRADE, false)) {
608                 $mform->addElement('checkbox', 'completionusegrade', get_string('completionusegrade', 'completion'),
609                     get_string('completionusegrade_desc', 'completion'));
610                 $mform->disabledIf('completionusegrade', 'completion', 'ne', COMPLETION_TRACKING_AUTOMATIC);
611                 $mform->addHelpButton('completionusegrade', 'completionusegrade', 'completion');
612                 $gotcompletionoptions = true;
613             }
615             // Automatic completion according to module-specific rules
616             $this->_customcompletionelements = $this->add_completion_rules();
617             foreach ($this->_customcompletionelements as $element) {
618                 $mform->disabledIf($element, 'completion', 'ne', COMPLETION_TRACKING_AUTOMATIC);
619             }
621             $gotcompletionoptions = $gotcompletionoptions ||
622                 count($this->_customcompletionelements)>0;
624             // Automatic option only appears if possible
625             if ($gotcompletionoptions) {
626                 $mform->getElement('completion')->addOption(
627                     get_string('completion_automatic', 'completion'),
628                     COMPLETION_TRACKING_AUTOMATIC);
629             }
631             // Completion expected at particular date? (For progress tracking)
632             $mform->addElement('date_selector', 'completionexpected', get_string('completionexpected', 'completion'), array('optional'=>true));
633             $mform->addHelpButton('completionexpected', 'completionexpected', 'completion');
634             $mform->disabledIf('completionexpected', 'completion', 'eq', COMPLETION_TRACKING_NONE);
635         }
637         $this->standard_hidden_coursemodule_elements();
638     }
640     /**
641      * Can be overridden to add custom completion rules if the module wishes
642      * them. If overriding this, you should also override completion_rule_enabled.
643      * <p>
644      * Just add elements to the form as needed and return the list of IDs. The
645      * system will call disabledIf and handle other behaviour for each returned
646      * ID.
647      * @return array Array of string IDs of added items, empty array if none
648      */
649     function add_completion_rules() {
650         return array();
651     }
653     /**
654      * Called during validation. Override to indicate, based on the data, whether
655      * a custom completion rule is enabled (selected).
656      *
657      * @param array $data Input data (not yet validated)
658      * @return bool True if one or more rules is enabled, false if none are;
659      *   default returns false
660      */
661     function completion_rule_enabled($data) {
662         return false;
663     }
665     function standard_hidden_coursemodule_elements(){
666         $mform =& $this->_form;
667         $mform->addElement('hidden', 'course', 0);
668         $mform->setType('course', PARAM_INT);
670         $mform->addElement('hidden', 'coursemodule', 0);
671         $mform->setType('coursemodule', PARAM_INT);
673         $mform->addElement('hidden', 'section', 0);
674         $mform->setType('section', PARAM_INT);
676         $mform->addElement('hidden', 'module', 0);
677         $mform->setType('module', PARAM_INT);
679         $mform->addElement('hidden', 'modulename', '');
680         $mform->setType('modulename', PARAM_PLUGIN);
682         $mform->addElement('hidden', 'instance', 0);
683         $mform->setType('instance', PARAM_INT);
685         $mform->addElement('hidden', 'add', 0);
686         $mform->setType('add', PARAM_ALPHA);
688         $mform->addElement('hidden', 'update', 0);
689         $mform->setType('update', PARAM_INT);
691         $mform->addElement('hidden', 'return', 0);
692         $mform->setType('return', PARAM_BOOL);
694         $mform->addElement('hidden', 'sr', 0);
695         $mform->setType('sr', PARAM_INT);
696     }
698     public function standard_grading_coursemodule_elements() {
699         global $COURSE, $CFG;
700         $mform =& $this->_form;
702         if ($this->_features->hasgrades) {
704             if (!$this->_features->rating || $this->_features->gradecat) {
705                 $mform->addElement('header', 'modstandardgrade', get_string('grade'));
706             }
708             //if supports grades and grades arent being handled via ratings
709             if (!$this->_features->rating) {
710                 $mform->addElement('modgrade', 'grade', get_string('grade'));
711                 $mform->setDefault('grade', 100);
712             }
714             if ($this->_features->advancedgrading
715                     and !empty($this->current->_advancedgradingdata['methods'])
716                     and !empty($this->current->_advancedgradingdata['areas'])) {
718                 if (count($this->current->_advancedgradingdata['areas']) == 1) {
719                     // if there is just one gradable area (most cases), display just the selector
720                     // without its name to make UI simplier
721                     $areadata = reset($this->current->_advancedgradingdata['areas']);
722                     $areaname = key($this->current->_advancedgradingdata['areas']);
723                     $mform->addElement('select', 'advancedgradingmethod_'.$areaname,
724                         get_string('gradingmethod', 'core_grading'), $this->current->_advancedgradingdata['methods']);
725                     $mform->addHelpButton('advancedgradingmethod_'.$areaname, 'gradingmethod', 'core_grading');
727                 } else {
728                     // the module defines multiple gradable areas, display a selector
729                     // for each of them together with a name of the area
730                     $areasgroup = array();
731                     foreach ($this->current->_advancedgradingdata['areas'] as $areaname => $areadata) {
732                         $areasgroup[] = $mform->createElement('select', 'advancedgradingmethod_'.$areaname,
733                             $areadata['title'], $this->current->_advancedgradingdata['methods']);
734                         $areasgroup[] = $mform->createElement('static', 'advancedgradingareaname_'.$areaname, '', $areadata['title']);
735                     }
736                     $mform->addGroup($areasgroup, 'advancedgradingmethodsgroup', get_string('gradingmethods', 'core_grading'),
737                         array(' ', '<br />'), false);
738                 }
739             }
741             if ($this->_features->gradecat) {
742                 $mform->addElement('select', 'gradecat',
743                         get_string('gradecategoryonmodform', 'grades'),
744                         grade_get_categories_menu($COURSE->id, $this->_outcomesused));
745                 $mform->addHelpButton('gradecat', 'gradecategoryonmodform', 'grades');
746             }
747         }
748     }
750     function add_intro_editor($required=false, $customlabel=null) {
751         if (!$this->_features->introeditor) {
752             // intro editor not supported in this module
753             return;
754         }
756         $mform = $this->_form;
757         $label = is_null($customlabel) ? get_string('moduleintro') : $customlabel;
759         $mform->addElement('editor', 'introeditor', $label, null, array('maxfiles'=>EDITOR_UNLIMITED_FILES, 'noclean'=>true, 'context'=>$this->context));
760         $mform->setType('introeditor', PARAM_RAW); // no XSS prevention here, users must be trusted
761         if ($required) {
762             $mform->addRule('introeditor', get_string('required'), 'required', null, 'client');
763         }
765         // If the 'show description' feature is enabled, this checkbox appears
766         // below the intro.
767         if ($this->_features->showdescription) {
768             $mform->addElement('checkbox', 'showdescription', get_string('showdescription'));
769             $mform->addHelpButton('showdescription', 'showdescription');
770         }
771     }
773     /**
774      * Overriding formslib's add_action_buttons() method, to add an extra submit "save changes and return" button.
775      *
776      * @param bool $cancel show cancel button
777      * @param string $submitlabel null means default, false means none, string is label text
778      * @param string $submit2label  null means default, false means none, string is label text
779      * @return void
780      */
781     function add_action_buttons($cancel=true, $submitlabel=null, $submit2label=null) {
782         if (is_null($submitlabel)) {
783             $submitlabel = get_string('savechangesanddisplay');
784         }
786         if (is_null($submit2label)) {
787             $submit2label = get_string('savechangesandreturntocourse');
788         }
790         $mform = $this->_form;
792         // elements in a row need a group
793         $buttonarray = array();
795         if ($submit2label !== false) {
796             $buttonarray[] = &$mform->createElement('submit', 'submitbutton2', $submit2label);
797         }
799         if ($submitlabel !== false) {
800             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submitlabel);
801         }
803         if ($cancel) {
804             $buttonarray[] = &$mform->createElement('cancel');
805         }
807         $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
808         $mform->setType('buttonar', PARAM_RAW);
809         $mform->closeHeaderBefore('buttonar');
810     }