course/moodleform_mod.php

   1 <?php
   2 require_once ($CFG->libdir.'/formslib.php');
   3 require_once($CFG->libdir.'/completionlib.php');
   4
   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;
  48
  49     /** a flag indicating whether outcomes are being used*/
  50     protected $_outcomesused;
  51
  52     /**
  53      * @var bool A flag used to indicate that this module should lock settings
  54      *           based on admin settings flags in definition_after_data.
  55      */
  56     protected $applyadminlockedflags = false;
  57
  58     /** @var object The course format of the current course. */
  59     protected $courseformat;
  60
  61     function moodleform_mod($current, $section, $cm, $course) {
  62         global $CFG;
  63
  64         $this->current   = $current;
  65         $this->_instance = $current->instance;
  66         $this->_section  = $section;
  67         $this->_cm       = $cm;
  68         if ($this->_cm) {
  69             $this->context = context_module::instance($this->_cm->id);
  70         } else {
  71             $this->context = context_course::instance($course->id);
  72         }
  73
  74         // Set the course format.
  75         require_once($CFG->dirroot . '/course/format/lib.php');
  76         $this->courseformat = course_get_format($course);
  77
  78         // Guess module name
  79         $matches = array();
  80         if (!preg_match('/^mod_([^_]+)_mod_form$/', get_class($this), $matches)) {
  81             debugging('Use $modname parameter or rename form to mod_xx_mod_form, where xx is name of your module');
  82             print_error('unknownmodulename');
  83         }
  84         $this->_modname = $matches[1];
  85         $this->init_features();
  86         parent::moodleform('modedit.php');
  87     }
  88
  89     protected function init_features() {
  90         global $CFG;
  91
  92         $this->_features = new stdClass();
  93         $this->_features->groups            = plugin_supports('mod', $this->_modname, FEATURE_GROUPS, true);
  94         $this->_features->groupings         = plugin_supports('mod', $this->_modname, FEATURE_GROUPINGS, false);
  95         $this->_features->groupmembersonly  = (!empty($CFG->enablegroupmembersonly) and plugin_supports('mod', $this->_modname, FEATURE_GROUPMEMBERSONLY, false));
  96         $this->_features->outcomes          = (!empty($CFG->enableoutcomes) and plugin_supports('mod', $this->_modname, FEATURE_GRADE_OUTCOMES, true));
  97         $this->_features->hasgrades         = plugin_supports('mod', $this->_modname, FEATURE_GRADE_HAS_GRADE, false);
  98         $this->_features->idnumber          = plugin_supports('mod', $this->_modname, FEATURE_IDNUMBER, true);
  99         $this->_features->introeditor       = plugin_supports('mod', $this->_modname, FEATURE_MOD_INTRO, true);
 100         $this->_features->defaultcompletion = plugin_supports('mod', $this->_modname, FEATURE_MODEDIT_DEFAULT_COMPLETION, true);
 101         $this->_features->rating            = plugin_supports('mod', $this->_modname, FEATURE_RATE, false);
 102         $this->_features->showdescription   = plugin_supports('mod', $this->_modname, FEATURE_SHOW_DESCRIPTION, false);
 103
 104         $this->_features->gradecat          = ($this->_features->outcomes or $this->_features->hasgrades);
 105         $this->_features->advancedgrading   = plugin_supports('mod', $this->_modname, FEATURE_ADVANCED_GRADING, false);
 106     }
 107
 108     /**
 109      * Only available on moodleform_mod.
 110      *
 111      * @param array $default_values passed by reference
 112      */
 113     function data_preprocessing(&$default_values){
 114         if (empty($default_values['scale'])) {
 115             $default_values['assessed'] = 0;
 116         }
 117
 118         if (empty($default_values['assessed'])){
 119             $default_values['ratingtime'] = 0;
 120         } else {
 121             $default_values['ratingtime']=
 122                 ($default_values['assesstimestart'] && $default_values['assesstimefinish']) ? 1 : 0;
 123         }
 124     }
 125
 126     /**
 127      * Each module which defines definition_after_data() must call this method using parent::definition_after_data();
 128      */
 129     function definition_after_data() {
 130         global $CFG, $COURSE;
 131         $mform =& $this->_form;
 132
 133         if ($id = $mform->getElementValue('update')) {
 134             $modulename = $mform->getElementValue('modulename');
 135             $instance   = $mform->getElementValue('instance');
 136
 137             if ($this->_features->gradecat) {
 138                 $gradecat = false;
 139                 if (!empty($CFG->enableoutcomes) and $this->_features->outcomes) {
 140                     $outcomes = grade_outcome::fetch_all_available($COURSE->id);
 141                     if (!empty($outcomes)) {
 142                         $gradecat = true;
 143                     }
 144                 }
 145
 146                 $items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,'iteminstance'=>$instance, 'courseid'=>$COURSE->id));
 147                 //will be no items if, for example, this activity supports ratings but rating aggregate type == no ratings
 148                 if (!empty($items)) {
 149                     foreach ($items as $item) {
 150                         if (!empty($item->outcomeid)) {
 151                             $elname = 'outcome_'.$item->outcomeid;
 152                             if ($mform->elementExists($elname)) {
 153                                 $mform->hardFreeze($elname); // prevent removing of existing outcomes
 154                             }
 155                         }
 156                     }
 157
 158                     foreach ($items as $item) {
 159                         if (is_bool($gradecat)) {
 160                             $gradecat = $item->categoryid;
 161                             continue;
 162                         }
 163                         if ($gradecat != $item->categoryid) {
 164                             //mixed categories
 165                             $gradecat = false;
 166                             break;
 167                         }
 168                     }
 169                 }
 170
 171                 if ($gradecat === false) {
 172                     // items and outcomes in different categories - remove the option
 173                     // TODO: add a "Mixed categories" text instead of removing elements with no explanation
 174                     if ($mform->elementExists('gradecat')) {
 175                         $mform->removeElement('gradecat');
 176                         if ($this->_features->rating) {
 177                             //if supports ratings then the max grade dropdown wasnt added so the grade box can be removed entirely
 178                             $mform->removeElement('modstandardgrade');
 179                         }
 180                     }
 181                 }
 182             }
 183         }
 184
 185         if ($COURSE->groupmodeforce) {
 186             if ($mform->elementExists('groupmode')) {
 187                 $mform->hardFreeze('groupmode'); // groupmode can not be changed if forced from course settings
 188             }
 189         }
 190
 191         // Don't disable/remove groupingid if it is currently set to something,
 192         // otherwise you cannot turn it off at same time as turning off other
 193         // option (MDL-30764)
 194         if (empty($this->_cm) || !$this->_cm->groupingid) {
 195             if ($mform->elementExists('groupmode') and !$mform->elementExists('groupmembersonly') and empty($COURSE->groupmodeforce)) {
 196                 $mform->disabledIf('groupingid', 'groupmode', 'eq', NOGROUPS);
 197
 198             } else if (!$mform->elementExists('groupmode') and $mform->elementExists('groupmembersonly')) {
 199                 $mform->disabledIf('groupingid', 'groupmembersonly', 'notchecked');
 200
 201             } else if (!$mform->elementExists('groupmode') and !$mform->elementExists('groupmembersonly')) {
 202                 // groupings have no use without groupmode or groupmembersonly
 203                 if ($mform->elementExists('groupingid')) {
 204                     $mform->removeElement('groupingid');
 205                 }
 206             }
 207         }
 208
 209         // Completion: If necessary, freeze fields
 210         $completion = new completion_info($COURSE);
 211         if ($completion->is_enabled()) {
 212             // If anybody has completed the activity, these options will be 'locked'
 213             $completedcount = empty($this->_cm)
 214                 ? 0
 215                 : $completion->count_user_data($this->_cm);
 216
 217             $freeze = false;
 218             if (!$completedcount) {
 219                 if ($mform->elementExists('unlockcompletion')) {
 220                     $mform->removeElement('unlockcompletion');
 221                 }
 222                 // Automatically set to unlocked (note: this is necessary
 223                 // in order to make it recalculate completion once the option
 224                 // is changed, maybe someone has completed it now)
 225                 $mform->getElement('completionunlocked')->setValue(1);
 226             } else {
 227                 // Has the element been unlocked?
 228                 if ($mform->exportValue('unlockcompletion')) {
 229                     // Yes, add in warning text and set the hidden variable
 230                     $mform->insertElementBefore(
 231                         $mform->createElement('static', 'completedunlocked',
 232                             get_string('completedunlocked', 'completion'),
 233                             get_string('completedunlockedtext', 'completion')),
 234                         'unlockcompletion');
 235                     $mform->removeElement('unlockcompletion');
 236                     $mform->getElement('completionunlocked')->setValue(1);
 237                 } else {
 238                     // No, add in the warning text with the count (now we know
 239                     // it) before the unlock button
 240                     $mform->insertElementBefore(
 241                         $mform->createElement('static', 'completedwarning',
 242                             get_string('completedwarning', 'completion'),
 243                             get_string('completedwarningtext', 'completion', $completedcount)),
 244                         'unlockcompletion');
 245                     $freeze = true;
 246                 }
 247             }
 248
 249             if ($freeze) {
 250                 $mform->freeze('completion');
 251                 if ($mform->elementExists('completionview')) {
 252                     $mform->freeze('completionview'); // don't use hardFreeze or checkbox value gets lost
 253                 }
 254                 if ($mform->elementExists('completionusegrade')) {
 255                     $mform->freeze('completionusegrade');
 256                 }
 257                 $mform->freeze($this->_customcompletionelements);
 258             }
 259         }
 260
 261         // Availability conditions
 262         if (!empty($CFG->enableavailability) && $this->_cm) {
 263             $ci = new condition_info($this->_cm);
 264             $fullcm=$ci->get_full_course_module();
 265
 266             $num=0;
 267             foreach($fullcm->conditionsgrade as $gradeitemid=>$minmax) {
 268                 $groupelements=$mform->getElement('conditiongradegroup['.$num.']')->getElements();
 269                 $groupelements[0]->setValue($gradeitemid);
 270                 $groupelements[2]->setValue(is_null($minmax->min) ? '' :
 271                         format_float($minmax->min, 5, true, true));
 272                 $groupelements[4]->setValue(is_null($minmax->max) ? '' :
 273                         format_float($minmax->max, 5, true, true));
 274                 $num++;
 275             }
 276
 277             $num = 0;
 278             foreach($fullcm->conditionsfield as $field => $details) {
 279                 $groupelements = $mform->getElement('conditionfieldgroup['.$num.']')->getElements();
 280                 $groupelements[0]->setValue($field);
 281                 $groupelements[1]->setValue(is_null($details->operator) ? '' : $details->operator);
 282                 $groupelements[2]->setValue(is_null($details->value) ? '' : $details->value);
 283                 $num++;
 284             }
 285
 286             if ($completion->is_enabled()) {
 287                 $num=0;
 288                 foreach($fullcm->conditionscompletion as $othercmid=>$state) {
 289                     $groupelements=$mform->getElement('conditioncompletiongroup['.$num.']')->getElements();
 290                     $groupelements[0]->setValue($othercmid);
 291                     $groupelements[1]->setValue($state);
 292                     $num++;
 293                 }
 294             }
 295         }
 296
 297         // Freeze admin defaults if required (and not different from default)
 298         $this->apply_admin_locked_flags();
 299     }
 300
 301     // form verification
 302     function validation($data, $files) {
 303         global $COURSE, $DB;
 304         $errors = parent::validation($data, $files);
 305
 306         $mform =& $this->_form;
 307
 308         $errors = array();
 309
 310         if ($mform->elementExists('name')) {
 311             $name = trim($data['name']);
 312             if ($name == '') {
 313                 $errors['name'] = get_string('required');
 314             }
 315         }
 316
 317         $grade_item = grade_item::fetch(array('itemtype'=>'mod', 'itemmodule'=>$data['modulename'],
 318                      'iteminstance'=>$data['instance'], 'itemnumber'=>0, 'courseid'=>$COURSE->id));
 319         if ($data['coursemodule']) {
 320             $cm = $DB->get_record('course_modules', array('id'=>$data['coursemodule']));
 321         } else {
 322             $cm = null;
 323         }
 324
 325         if ($mform->elementExists('cmidnumber')) {
 326             // verify the idnumber
 327             if (!grade_verify_idnumber($data['cmidnumber'], $COURSE->id, $grade_item, $cm)) {
 328                 $errors['cmidnumber'] = get_string('idnumbertaken');
 329             }
 330         }
 331
 332         // Completion: Don't let them choose automatic completion without turning
 333         // on some conditions. Ignore this check when completion settings are
 334         // locked, as the options are then disabled.
 335         if (array_key_exists('completion', $data) &&
 336                 $data['completion'] == COMPLETION_TRACKING_AUTOMATIC &&
 337                 !empty($data['completionunlocked'])) {
 338             if (empty($data['completionview']) && empty($data['completionusegrade']) &&
 339                 !$this->completion_rule_enabled($data)) {
 340                 $errors['completion'] = get_string('badautocompletion', 'completion');
 341             }
 342         }
 343
 344         // Conditions: Don't let them set dates which make no sense
 345         if (array_key_exists('availablefrom', $data) &&
 346             $data['availablefrom'] && $data['availableuntil'] &&
 347             $data['availablefrom'] >= $data['availableuntil']) {
 348             $errors['availablefrom'] = get_string('badavailabledates', 'condition');
 349         }
 350
 351         // Conditions: Verify that the grade conditions are numbers, and make sense.
 352         if (array_key_exists('conditiongradegroup', $data)) {
 353             foreach ($data['conditiongradegroup'] as $i => $gradedata) {
 354                 if ($gradedata['conditiongrademin'] !== '' &&
 355                         !is_numeric(unformat_float($gradedata['conditiongrademin']))) {
 356                     $errors["conditiongradegroup[{$i}]"] = get_string('gradesmustbenumeric', 'condition');
 357                     continue;
 358                 }
 359                 if ($gradedata['conditiongrademax'] !== '' &&
 360                         !is_numeric(unformat_float($gradedata['conditiongrademax']))) {
 361                     $errors["conditiongradegroup[{$i}]"] = get_string('gradesmustbenumeric', 'condition');
 362                     continue;
 363                 }
 364                 if ($gradedata['conditiongrademin'] !== '' && $gradedata['conditiongrademax'] !== '' &&
 365                         unformat_float($gradedata['conditiongrademax']) <= unformat_float($gradedata['conditiongrademin'])) {
 366                     $errors["conditiongradegroup[{$i}]"] = get_string('badgradelimits', 'condition');
 367                     continue;
 368                 }
 369                 if ($gradedata['conditiongrademin'] === '' && $gradedata['conditiongrademax'] === '' &&
 370                         $gradedata['conditiongradeitemid']) {
 371                     $errors["conditiongradegroup[{$i}]"] = get_string('gradeitembutnolimits', 'condition');
 372                     continue;
 373                 }
 374                 if (($gradedata['conditiongrademin'] !== '' || $gradedata['conditiongrademax'] !== '') &&
 375                         !$gradedata['conditiongradeitemid']) {
 376                     $errors["conditiongradegroup[{$i}]"] = get_string('gradelimitsbutnoitem', 'condition');
 377                     continue;
 378                 }
 379             }
 380         }
 381
 382         // Conditions: Verify that the user profile field has not been declared more than once
 383         if (array_key_exists('conditionfieldgroup', $data)) {
 384             // Array to store the existing fields
 385             $arrcurrentfields = array();
 386             // Error message displayed if any condition is declared more than once. We use lang string because
 387             // this way we don't actually generate the string unless there is an error.
 388             $stralreadydeclaredwarning = new lang_string('fielddeclaredmultipletimes', 'condition');
 389             foreach ($data['conditionfieldgroup'] as $i => $fielddata) {
 390                 if ($fielddata['conditionfield'] == 0) { // Don't need to bother if none is selected
 391                     continue;
 392                 }
 393                 if (in_array($fielddata['conditionfield'], $arrcurrentfields)) {
 394                     $errors["conditionfieldgroup[{$i}]"] = $stralreadydeclaredwarning->out();
 395                 }
 396                 // Add the field to the array
 397                 $arrcurrentfields[] = $fielddata['conditionfield'];
 398             }
 399         }
 400
 401         return $errors;
 402     }
 403
 404     /**
 405      * Load in existing data as form defaults. Usually new entry defaults are stored directly in
 406      * form definition (new entry form); this function is used to load in data where values
 407      * already exist and data is being edited (edit entry form).
 408      *
 409      * @param mixed $default_values object or array of default values
 410      */
 411     function set_data($default_values) {
 412         if (is_object($default_values)) {
 413             $default_values = (array)$default_values;
 414         }
 415
 416         $this->data_preprocessing($default_values);
 417         parent::set_data($default_values);
 418     }
 419
 420     /**
 421      * Adds all the standard elements to a form to edit the settings for an activity module.
 422      */
 423     function standard_coursemodule_elements(){
 424         global $COURSE, $CFG, $DB;
 425         $mform =& $this->_form;
 426
 427         $this->_outcomesused = false;
 428         if ($this->_features->outcomes) {
 429             if ($outcomes = grade_outcome::fetch_all_available($COURSE->id)) {
 430                 $this->_outcomesused = true;
 431                 $mform->addElement('header', 'modoutcomes', get_string('outcomes', 'grades'));
 432                 foreach($outcomes as $outcome) {
 433                     $mform->addElement('advcheckbox', 'outcome_'.$outcome->id, $outcome->get_name());
 434                 }
 435             }
 436         }
 437
 438
 439         if ($this->_features->rating) {
 440             require_once($CFG->dirroot.'/rating/lib.php');
 441             $rm = new rating_manager();
 442
 443             $mform->addElement('header', 'modstandardratings', get_string('ratings', 'rating'));
 444
 445             $permission=CAP_ALLOW;
 446             $rolenamestring = null;
 447             if (!empty($this->_cm)) {
 448                 $context = context_module::instance($this->_cm->id);
 449
 450                 $rolenames = get_role_names_with_caps_in_context($context, array('moodle/rating:rate', 'mod/'.$this->_cm->modname.':rate'));
 451                 $rolenamestring = implode(', ', $rolenames);
 452             } else {
 453                 $rolenamestring = get_string('capabilitychecknotavailable','rating');
 454             }
 455             $mform->addElement('static', 'rolewarning', get_string('rolewarning','rating'), $rolenamestring);
 456             $mform->addHelpButton('rolewarning', 'rolewarning', 'rating');
 457
 458             $mform->addElement('select', 'assessed', get_string('aggregatetype', 'rating') , $rm->get_aggregate_types());
 459             $mform->setDefault('assessed', 0);
 460             $mform->addHelpButton('assessed', 'aggregatetype', 'rating');
 461
 462             $mform->addElement('modgrade', 'scale', get_string('scale'), false);
 463             $mform->disabledIf('scale', 'assessed', 'eq', 0);
 464
 465             $mform->addElement('checkbox', 'ratingtime', get_string('ratingtime', 'rating'));
 466             $mform->disabledIf('ratingtime', 'assessed', 'eq', 0);
 467
 468             $mform->addElement('date_time_selector', 'assesstimestart', get_string('from'));
 469             $mform->disabledIf('assesstimestart', 'assessed', 'eq', 0);
 470             $mform->disabledIf('assesstimestart', 'ratingtime');
 471
 472             $mform->addElement('date_time_selector', 'assesstimefinish', get_string('to'));
 473             $mform->disabledIf('assesstimefinish', 'assessed', 'eq', 0);
 474             $mform->disabledIf('assesstimefinish', 'ratingtime');
 475         }
 476
 477         //doing this here means splitting up the grade related settings on the lesson settings page
 478         //$this->standard_grading_coursemodule_elements();
 479
 480         $mform->addElement('header', 'modstandardelshdr', get_string('modstandardels', 'form'));
 481
 482         $mform->addElement('modvisible', 'visible', get_string('visible'));
 483         if (!empty($this->_cm)) {
 484             $context = context_module::instance($this->_cm->id);
 485             if (!has_capability('moodle/course:activityvisibility', $context)) {
 486                 $mform->hardFreeze('visible');
 487             }
 488         }
 489
 490         if ($this->_features->idnumber) {
 491             $mform->addElement('text', 'cmidnumber', get_string('idnumbermod'));
 492             $mform->setType('cmidnumber', PARAM_RAW);
 493             $mform->addHelpButton('cmidnumber', 'idnumbermod');
 494         }
 495
 496         if ($this->_features->groups) {
 497             $options = array(NOGROUPS       => get_string('groupsnone'),
 498                              SEPARATEGROUPS => get_string('groupsseparate'),
 499                              VISIBLEGROUPS  => get_string('groupsvisible'));
 500             $mform->addElement('select', 'groupmode', get_string('groupmode', 'group'), $options, NOGROUPS);
 501             $mform->addHelpButton('groupmode', 'groupmode', 'group');
 502         }
 503
 504         if ($this->_features->groupings or $this->_features->groupmembersonly) {
 505             //groupings selector - used for normal grouping mode or also when restricting access with groupmembersonly
 506             $options = array();
 507             $options[0] = get_string('none');
 508             if ($groupings = $DB->get_records('groupings', array('courseid'=>$COURSE->id))) {
 509                 foreach ($groupings as $grouping) {
 510                     $options[$grouping->id] = format_string($grouping->name);
 511                 }
 512             }
 513             $mform->addElement('select', 'groupingid', get_string('grouping', 'group'), $options);
 514             $mform->addHelpButton('groupingid', 'grouping', 'group');
 515         }
 516
 517         if ($this->_features->groupmembersonly) {
 518             $mform->addElement('checkbox', 'groupmembersonly', get_string('groupmembersonly', 'group'));
 519             $mform->addHelpButton('groupmembersonly', 'groupmembersonly', 'group');
 520         }
 521
 522         if (!empty($CFG->enableavailability)) {
 523             // String used by conditions
 524             $strnone = get_string('none','condition');
 525             // Conditional availability
 526
 527             // Available from/to defaults to midnight because then the display
 528             // will be nicer where it tells users when they can access it (it
 529             // shows only the date and not time).
 530             $date = usergetdate(time());
 531             $midnight = make_timestamp($date['year'], $date['mon'], $date['mday']);
 532
 533             // From/until controls
 534             $mform->addElement('header', 'availabilityconditionsheader',
 535                     get_string('availabilityconditions', 'condition'));
 536             $mform->addElement('date_time_selector', 'availablefrom',
 537                     get_string('availablefrom', 'condition'),
 538                     array('optional' => true, 'defaulttime' => $midnight));
 539             $mform->addHelpButton('availablefrom', 'availablefrom', 'condition');
 540             $mform->addElement('date_time_selector', 'availableuntil',
 541                     get_string('availableuntil', 'condition'),
 542                     array('optional' => true, 'defaulttime' => $midnight));
 543
 544             // Conditions based on grades
 545             $gradeoptions = array();
 546             $items = grade_item::fetch_all(array('courseid'=>$COURSE->id));
 547             $items = $items ? $items : array();
 548             foreach($items as $id=>$item) {
 549                 // Do not include grades for current item
 550                 if (!empty($this->_cm) && $this->_cm->instance == $item->iteminstance
 551                     && $this->_cm->modname == $item->itemmodule
 552                     && $item->itemtype == 'mod') {
 553                     continue;
 554                 }
 555                 $gradeoptions[$id] = $item->get_name();
 556             }
 557             asort($gradeoptions);
 558             $gradeoptions = array(0 => $strnone) + $gradeoptions;
 559
 560             $grouparray = array();
 561             $grouparray[] =& $mform->createElement('select','conditiongradeitemid','',$gradeoptions);
 562             $grouparray[] =& $mform->createElement('static', '', '',' '.get_string('grade_atleast','condition').' ');
 563             $grouparray[] =& $mform->createElement('text', 'conditiongrademin','',array('size'=>3));
 564             $grouparray[] =& $mform->createElement('static', '', '','% '.get_string('grade_upto','condition').' ');
 565             $grouparray[] =& $mform->createElement('text', 'conditiongrademax','',array('size'=>3));
 566             $grouparray[] =& $mform->createElement('static', '', '','%');
 567             $group = $mform->createElement('group','conditiongradegroup',
 568                 get_string('gradecondition', 'condition'),$grouparray);
 569
 570             // Get version with condition info and store it so we don't ask
 571             // twice
 572             if(!empty($this->_cm)) {
 573                 $ci = new condition_info($this->_cm, CONDITION_MISSING_EXTRATABLE);
 574                 $this->_cm = $ci->get_full_course_module();
 575                 $count = count($this->_cm->conditionsgrade)+1;
 576                 $fieldcount = count($this->_cm->conditionsfield) + 1;
 577             } else {
 578                 $count = 1;
 579                 $fieldcount = 1;
 580             }
 581
 582             $this->repeat_elements(array($group), $count, array(
 583                 'conditiongradegroup[conditiongrademin]' => array('type' => PARAM_RAW),
 584                 'conditiongradegroup[conditiongrademax]' => array('type' => PARAM_RAW)
 585                 ), 'conditiongraderepeats', 'conditiongradeadds', 2, get_string('addgrades', 'condition'), true);
 586             $mform->addHelpButton('conditiongradegroup[0]', 'gradecondition', 'condition');
 587
 588             // Conditions based on user fields
 589             $operators = condition_info::get_condition_user_field_operators();
 590             $useroptions = condition_info::get_condition_user_fields(
 591                     array('context' => $this->context));
 592             asort($useroptions);
 593
 594             $useroptions = array(0 => $strnone) + $useroptions;
 595             $grouparray = array();
 596             $grouparray[] =& $mform->createElement('select', 'conditionfield', '', $useroptions);
 597             $grouparray[] =& $mform->createElement('select', 'conditionfieldoperator', '', $operators);
 598             $grouparray[] =& $mform->createElement('text', 'conditionfieldvalue');
 599             $group = $mform->createElement('group', 'conditionfieldgroup', get_string('userfield', 'condition'), $grouparray);
 600
 601             $this->repeat_elements(array($group), $fieldcount, array(
 602                 'conditionfieldgroup[conditionfieldvalue]' => array('type' => PARAM_RAW)),
 603                 'conditionfieldrepeats', 'conditionfieldadds', 2, get_string('adduserfields', 'condition'), true);
 604             $mform->addHelpButton('conditionfieldgroup[0]', 'userfield', 'condition');
 605
 606             // Conditions based on completion
 607             $completion = new completion_info($COURSE);
 608             if ($completion->is_enabled()) {
 609                 $completionoptions = array();
 610                 $modinfo = get_fast_modinfo($COURSE);
 611                 foreach($modinfo->cms as $id=>$cm) {
 612                     // Add each course-module if it:
 613                     // (a) has completion turned on
 614                     // (b) is not the same as current course-module
 615                     if ($cm->completion && (empty($this->_cm) || $this->_cm->id != $id)) {
 616                         $completionoptions[$id]=$cm->name;
 617                     }
 618                 }
 619                 asort($completionoptions);
 620                 $completionoptions = array(0 => $strnone) + $completionoptions;
 621
 622                 $completionvalues=array(
 623                     COMPLETION_COMPLETE=>get_string('completion_complete','condition'),
 624                     COMPLETION_INCOMPLETE=>get_string('completion_incomplete','condition'),
 625                     COMPLETION_COMPLETE_PASS=>get_string('completion_pass','condition'),
 626                     COMPLETION_COMPLETE_FAIL=>get_string('completion_fail','condition'));
 627
 628                 $grouparray = array();
 629                 $grouparray[] =& $mform->createElement('select','conditionsourcecmid','',$completionoptions);
 630                 $grouparray[] =& $mform->createElement('select','conditionrequiredcompletion','',$completionvalues);
 631                 $group = $mform->createElement('group','conditioncompletiongroup',
 632                     get_string('completioncondition', 'condition'),$grouparray);
 633
 634                 $count = empty($this->_cm) ? 1 : count($this->_cm->conditionscompletion)+1;
 635                 $this->repeat_elements(array($group),$count,array(),
 636                     'conditioncompletionrepeats','conditioncompletionadds',2,
 637                     get_string('addcompletions','condition'),true);
 638                 $mform->addHelpButton('conditioncompletiongroup[0]', 'completioncondition', 'condition');
 639             }
 640
 641             // Do we display availability info to students?
 642             $mform->addElement('select', 'showavailability', get_string('showavailability', 'condition'),
 643                     array(CONDITION_STUDENTVIEW_SHOW=>get_string('showavailability_show', 'condition'),
 644                     CONDITION_STUDENTVIEW_HIDE=>get_string('showavailability_hide', 'condition')));
 645             $mform->setDefault('showavailability', CONDITION_STUDENTVIEW_SHOW);
 646         }
 647
 648         // Conditional activities: completion tracking section
 649         if(!isset($completion)) {
 650             $completion = new completion_info($COURSE);
 651         }
 652         if ($completion->is_enabled()) {
 653             $mform->addElement('header', 'activitycompletionheader', get_string('activitycompletion', 'completion'));
 654
 655             // Unlock button for if people have completed it (will
 656             // be removed in definition_after_data if they haven't)
 657             $mform->addElement('submit', 'unlockcompletion', get_string('unlockcompletion', 'completion'));
 658             $mform->registerNoSubmitButton('unlockcompletion');
 659             $mform->addElement('hidden', 'completionunlocked', 0);
 660             $mform->setType('completionunlocked', PARAM_INT);
 661
 662             $trackingdefault = COMPLETION_TRACKING_NONE;
 663             // If system and activity default is on, set it.
 664             if ($CFG->completiondefault && $this->_features->defaultcompletion) {
 665                 $trackingdefault = COMPLETION_TRACKING_MANUAL;
 666             }
 667
 668             $mform->addElement('select', 'completion', get_string('completion', 'completion'),
 669                 array(COMPLETION_TRACKING_NONE=>get_string('completion_none', 'completion'),
 670                 COMPLETION_TRACKING_MANUAL=>get_string('completion_manual', 'completion')));
 671             $mform->setDefault('completion', $trackingdefault);
 672             $mform->addHelpButton('completion', 'completion', 'completion');
 673
 674             // Automatic completion once you view it
 675             $gotcompletionoptions = false;
 676             if (plugin_supports('mod', $this->_modname, FEATURE_COMPLETION_TRACKS_VIEWS, false)) {
 677                 $mform->addElement('checkbox', 'completionview', get_string('completionview', 'completion'),
 678                     get_string('completionview_desc', 'completion'));
 679                 $mform->disabledIf('completionview', 'completion', 'ne', COMPLETION_TRACKING_AUTOMATIC);
 680                 $gotcompletionoptions = true;
 681             }
 682
 683             // Automatic completion once it's graded
 684             if (plugin_supports('mod', $this->_modname, FEATURE_GRADE_HAS_GRADE, false)) {
 685                 $mform->addElement('checkbox', 'completionusegrade', get_string('completionusegrade', 'completion'),
 686                     get_string('completionusegrade_desc', 'completion'));
 687                 $mform->disabledIf('completionusegrade', 'completion', 'ne', COMPLETION_TRACKING_AUTOMATIC);
 688                 $mform->addHelpButton('completionusegrade', 'completionusegrade', 'completion');
 689                 $gotcompletionoptions = true;
 690             }
 691
 692             // Automatic completion according to module-specific rules
 693             $this->_customcompletionelements = $this->add_completion_rules();
 694             foreach ($this->_customcompletionelements as $element) {
 695                 $mform->disabledIf($element, 'completion', 'ne', COMPLETION_TRACKING_AUTOMATIC);
 696             }
 697
 698             $gotcompletionoptions = $gotcompletionoptions ||
 699                 count($this->_customcompletionelements)>0;
 700
 701             // Automatic option only appears if possible
 702             if ($gotcompletionoptions) {
 703                 $mform->getElement('completion')->addOption(
 704                     get_string('completion_automatic', 'completion'),
 705                     COMPLETION_TRACKING_AUTOMATIC);
 706             }
 707
 708             // Completion expected at particular date? (For progress tracking)
 709             $mform->addElement('date_selector', 'completionexpected', get_string('completionexpected', 'completion'), array('optional'=>true));
 710             $mform->addHelpButton('completionexpected', 'completionexpected', 'completion');
 711             $mform->disabledIf('completionexpected', 'completion', 'eq', COMPLETION_TRACKING_NONE);
 712         }
 713
 714         $this->standard_hidden_coursemodule_elements();
 715     }
 716
 717     /**
 718      * Can be overridden to add custom completion rules if the module wishes
 719      * them. If overriding this, you should also override completion_rule_enabled.
 720      * <p>
 721      * Just add elements to the form as needed and return the list of IDs. The
 722      * system will call disabledIf and handle other behaviour for each returned
 723      * ID.
 724      * @return array Array of string IDs of added items, empty array if none
 725      */
 726     function add_completion_rules() {
 727         return array();
 728     }
 729
 730     /**
 731      * Called during validation. Override to indicate, based on the data, whether
 732      * a custom completion rule is enabled (selected).
 733      *
 734      * @param array $data Input data (not yet validated)
 735      * @return bool True if one or more rules is enabled, false if none are;
 736      *   default returns false
 737      */
 738     function completion_rule_enabled($data) {
 739         return false;
 740     }
 741
 742     function standard_hidden_coursemodule_elements(){
 743         $mform =& $this->_form;
 744         $mform->addElement('hidden', 'course', 0);
 745         $mform->setType('course', PARAM_INT);
 746
 747         $mform->addElement('hidden', 'coursemodule', 0);
 748         $mform->setType('coursemodule', PARAM_INT);
 749
 750         $mform->addElement('hidden', 'section', 0);
 751         $mform->setType('section', PARAM_INT);
 752
 753         $mform->addElement('hidden', 'module', 0);
 754         $mform->setType('module', PARAM_INT);
 755
 756         $mform->addElement('hidden', 'modulename', '');
 757         $mform->setType('modulename', PARAM_PLUGIN);
 758
 759         $mform->addElement('hidden', 'instance', 0);
 760         $mform->setType('instance', PARAM_INT);
 761
 762         $mform->addElement('hidden', 'add', 0);
 763         $mform->setType('add', PARAM_ALPHA);
 764
 765         $mform->addElement('hidden', 'update', 0);
 766         $mform->setType('update', PARAM_INT);
 767
 768         $mform->addElement('hidden', 'return', 0);
 769         $mform->setType('return', PARAM_BOOL);
 770
 771         $mform->addElement('hidden', 'sr', 0);
 772         $mform->setType('sr', PARAM_INT);
 773     }
 774
 775     public function standard_grading_coursemodule_elements() {
 776         global $COURSE, $CFG;
 777         $mform =& $this->_form;
 778
 779         if ($this->_features->hasgrades) {
 780
 781             if (!$this->_features->rating || $this->_features->gradecat) {
 782                 $mform->addElement('header', 'modstandardgrade', get_string('grade'));
 783             }
 784
 785             //if supports grades and grades arent being handled via ratings
 786             if (!$this->_features->rating) {
 787                 $mform->addElement('modgrade', 'grade', get_string('grade'));
 788                 $mform->setDefault('grade', 100);
 789             }
 790
 791             if ($this->_features->advancedgrading
 792                     and !empty($this->current->_advancedgradingdata['methods'])
 793                     and !empty($this->current->_advancedgradingdata['areas'])) {
 794
 795                 if (count($this->current->_advancedgradingdata['areas']) == 1) {
 796                     // if there is just one gradable area (most cases), display just the selector
 797                     // without its name to make UI simplier
 798                     $areadata = reset($this->current->_advancedgradingdata['areas']);
 799                     $areaname = key($this->current->_advancedgradingdata['areas']);
 800                     $mform->addElement('select', 'advancedgradingmethod_'.$areaname,
 801                         get_string('gradingmethod', 'core_grading'), $this->current->_advancedgradingdata['methods']);
 802                     $mform->addHelpButton('advancedgradingmethod_'.$areaname, 'gradingmethod', 'core_grading');
 803
 804                 } else {
 805                     // the module defines multiple gradable areas, display a selector
 806                     // for each of them together with a name of the area
 807                     $areasgroup = array();
 808                     foreach ($this->current->_advancedgradingdata['areas'] as $areaname => $areadata) {
 809                         $areasgroup[] = $mform->createElement('select', 'advancedgradingmethod_'.$areaname,
 810                             $areadata['title'], $this->current->_advancedgradingdata['methods']);
 811                         $areasgroup[] = $mform->createElement('static', 'advancedgradingareaname_'.$areaname, '', $areadata['title']);
 812                     }
 813                     $mform->addGroup($areasgroup, 'advancedgradingmethodsgroup', get_string('gradingmethods', 'core_grading'),
 814                         array(' ', '<br />'), false);
 815                 }
 816             }
 817
 818             if ($this->_features->gradecat) {
 819                 $mform->addElement('select', 'gradecat',
 820                         get_string('gradecategoryonmodform', 'grades'),
 821                         grade_get_categories_menu($COURSE->id, $this->_outcomesused));
 822                 $mform->addHelpButton('gradecat', 'gradecategoryonmodform', 'grades');
 823             }
 824         }
 825     }
 826
 827     function add_intro_editor($required=false, $customlabel=null) {
 828         if (!$this->_features->introeditor) {
 829             // intro editor not supported in this module
 830             return;
 831         }
 832
 833         $mform = $this->_form;
 834         $label = is_null($customlabel) ? get_string('moduleintro') : $customlabel;
 835
 836         $mform->addElement('editor', 'introeditor', $label, array('rows' => 10), array('maxfiles' => EDITOR_UNLIMITED_FILES,
 837             'noclean' => true, 'context' => $this->context, 'subdirs' => true));
 838         $mform->setType('introeditor', PARAM_RAW); // no XSS prevention here, users must be trusted
 839         if ($required) {
 840             $mform->addRule('introeditor', get_string('required'), 'required', null, 'client');
 841         }
 842
 843         // If the 'show description' feature is enabled, this checkbox appears below the intro.
 844         // We want to hide that when using the singleactivity course format because it is confusing.
 845         if ($this->_features->showdescription  && $this->courseformat->has_view_page()) {
 846             $mform->addElement('checkbox', 'showdescription', get_string('showdescription'));
 847             $mform->addHelpButton('showdescription', 'showdescription');
 848         }
 849     }
 850
 851     /**
 852      * Overriding formslib's add_action_buttons() method, to add an extra submit "save changes and return" button.
 853      *
 854      * @param bool $cancel show cancel button
 855      * @param string $submitlabel null means default, false means none, string is label text
 856      * @param string $submit2label  null means default, false means none, string is label text
 857      * @return void
 858      */
 859     function add_action_buttons($cancel=true, $submitlabel=null, $submit2label=null) {
 860         if (is_null($submitlabel)) {
 861             $submitlabel = get_string('savechangesanddisplay');
 862         }
 863
 864         if (is_null($submit2label)) {
 865             $submit2label = get_string('savechangesandreturntocourse');
 866         }
 867
 868         $mform = $this->_form;
 869
 870         // elements in a row need a group
 871         $buttonarray = array();
 872
 873         // Label for the submit button to return to the course.
 874         // Ignore this button in single activity format because it is confusing.
 875         if ($submit2label !== false && $this->courseformat->has_view_page()) {
 876             $buttonarray[] = &$mform->createElement('submit', 'submitbutton2', $submit2label);
 877         }
 878
 879         if ($submitlabel !== false) {
 880             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submitlabel);
 881         }
 882
 883         if ($cancel) {
 884             $buttonarray[] = &$mform->createElement('cancel');
 885         }
 886
 887         $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
 888         $mform->setType('buttonar', PARAM_RAW);
 889         $mform->closeHeaderBefore('buttonar');
 890     }
 891
 892     /**
 893      * Get the list of admin settings for this module and apply any locked settings.
 894      * This cannot happen in apply_admin_defaults because we do not the current values of the settings
 895      * in that function because set_data has not been called yet.
 896      *
 897      * @return void
 898      */
 899     protected function apply_admin_locked_flags() {
 900         global $OUTPUT;
 901
 902         if (!$this->applyadminlockedflags) {
 903             return;
 904         }
 905
 906         $settings = get_config($this->_modname);
 907         $mform = $this->_form;
 908         $lockedicon = html_writer::tag('span',
 909                                        $OUTPUT->pix_icon('t/locked', get_string('locked', 'admin')),
 910                                        array('class' => 'action-icon'));
 911         $isupdate = !empty($this->_cm);
 912
 913         foreach ($settings as $name => $value) {
 914             if (strpos('_', $name) !== false) {
 915                 continue;
 916             }
 917             if ($mform->elementExists($name)) {
 918                 $element = $mform->getElement($name);
 919                 $lockedsetting = $name . '_locked';
 920                 if (!empty($settings->$lockedsetting)) {
 921                     // Always lock locked settings for new modules,
 922                     // for updates, only lock them if the current value is the same as the default (or there is no current value).
 923                     $value = $settings->$name;
 924                     if ($isupdate && isset($this->current->$name)) {
 925                         $value = $this->current->$name;
 926                     }
 927                     if ($value == $settings->$name) {
 928                         $mform->setConstant($name, $settings->$name);
 929                         $element->setLabel($element->getLabel() . $lockedicon);
 930                         // Do not use hardfreeze because we need the hidden input to check dependencies.
 931                         $element->freeze();
 932                     }
 933                 }
 934             }
 935         }
 936     }
 937
 938     /**
 939      * Get the list of admin settings for this module and apply any defaults/advanced/locked settings.
 940      *
 941      * @param $datetimeoffsets array - If passed, this is an array of fieldnames => times that the
 942      *                         default date/time value should be relative to. If not passed, all
 943      *                         date/time fields are set relative to the users current midnight.
 944      * @return void
 945      */
 946     public function apply_admin_defaults($datetimeoffsets = array()) {
 947         // This flag triggers the settings to be locked in apply_admin_locked_flags().
 948         $this->applyadminlockedflags = true;
 949
 950         $settings = get_config($this->_modname);
 951         $mform = $this->_form;
 952         $usermidnight = usergetmidnight(time());
 953         $isupdate = !empty($this->_cm);
 954
 955         foreach ($settings as $name => $value) {
 956             if (strpos('_', $name) !== false) {
 957                 continue;
 958             }
 959             if ($mform->elementExists($name)) {
 960                 $element = $mform->getElement($name);
 961                 if (!$isupdate) {
 962                     if ($element->getType() == 'date_time_selector') {
 963                         $enabledsetting = $name . '_enabled';
 964                         if (empty($settings->$enabledsetting)) {
 965                             $mform->setDefault($name, 0);
 966                         } else {
 967                             $relativetime = $usermidnight;
 968                             if (isset($datetimeoffsets[$name])) {
 969                                 $relativetime = $datetimeoffsets[$name];
 970                             }
 971                             $mform->setDefault($name, $relativetime + $settings->$name);
 972                         }
 973                     } else {
 974                         $mform->setDefault($name, $settings->$name);
 975                     }
 976                 }
 977                 $advancedsetting = $name . '_adv';
 978                 if (!empty($settings->$advancedsetting)) {
 979                     $mform->setAdvanced($name);
 980                 }
 981             }
 982         }
 983     }
 984 }
 985
 986