course/moodleform_mod.php

   1 <?php
   2
   3 if (!defined('MOODLE_INTERNAL')) {
   4     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
   5 }
   6
   7 require_once ($CFG->libdir.'/formslib.php');
   8 /**
   9  * This class adds extra methods to form wrapper specific to be used for module
  10  * add / update forms (mod/{modname}.mod_form.php replaces deprecated mod/{modname}/mod.html
  11  *
  12  */
  13 class moodleform_mod extends moodleform {
  14     /**
  15      * Instance of the module that is being updated. This is the id of the {prefix}{modulename}
  16      * record. Can be used in form definition. Will be "" if this is an 'add' form and not an
  17      * update one.
  18      *
  19      * @var mixed
  20      */
  21     var $_instance;
  22     /**
  23      * Section of course that module instance will be put in or is in.
  24      * This is always the section number itself (column 'section' from 'course_sections' table).
  25      *
  26      * @var mixed
  27      */
  28     var $_section;
  29     /**
  30      * Coursemodle record of the module that is being updated. Will be null if this is an 'add' form and not an
  31      * update one.
  32       *
  33      * @var mixed
  34      */
  35     var $_cm;
  36     /**
  37      * List of modform features
  38      */
  39     var $_features;
  40
  41     function moodleform_mod($instance, $section, $cm) {
  42         $this->_instance = $instance;
  43         $this->_section = $section;
  44         $this->_cm = $cm;
  45         parent::moodleform('modedit.php');
  46     }
  47
  48     /**
  49      * Only available on moodleform_mod.
  50      *
  51      * @param array $default_values passed by reference
  52      */
  53     function data_preprocessing(&$default_values){
  54     }
  55
  56     /**
  57      * Each module which defines definition_after_data() must call this method using parent::definition_after_data();
  58      */
  59     function definition_after_data() {
  60         global $CFG, $COURSE;
  61         $mform =& $this->_form;
  62
  63         if ($id = $mform->getElementValue('update')) {
  64             $modulename = $mform->getElementValue('modulename');
  65             $instance   = $mform->getElementValue('instance');
  66
  67             if ($this->_features->gradecat) {
  68                 $gradecat = false;
  69                 if (!empty($CFG->enableoutcomes) and $this->_features->outcomes) {
  70                     if ($outcomes = grade_outcome::fetch_all_available($COURSE->id)) {
  71                         $gradecat = true;
  72                     }
  73                 }
  74                 if ($items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
  75                                                    'iteminstance'=>$instance, 'courseid'=>$COURSE->id))) {
  76                     foreach ($items as $item) {
  77                         if (!empty($item->outcomeid)) {
  78                             $elname = 'outcome_'.$item->outcomeid;
  79                             if ($mform->elementExists($elname)) {
  80                                 $mform->hardFreeze($elname); // prevent removing of existing outcomes
  81                             }
  82                         }
  83                     }
  84                     foreach ($items as $item) {
  85                         if (is_bool($gradecat)) {
  86                             $gradecat = $item->categoryid;
  87                             continue;
  88                         }
  89                         if ($gradecat != $item->categoryid) {
  90                             //mixed categories
  91                             $gradecat = false;
  92                             break;
  93                         }
  94                     }
  95                 }
  96
  97                 if ($gradecat === false) {
  98                     // items and outcomes in different categories - remove the option
  99                     // TODO: it might be better to add a "Mixed categories" text instead
 100                     if ($mform->elementExists('gradecat')) {
 101                         $mform->removeElement('gradecat');
 102                     }
 103                 }
 104             }
 105         }
 106
 107         if ($COURSE->groupmodeforce) {
 108             if ($mform->elementExists('groupmode')) {
 109                 $mform->hardFreeze('groupmode'); // groupmode can not be changed if forced from course settings
 110             }
 111         }
 112
 113         if ($mform->elementExists('groupmode') and !$mform->elementExists('groupmembersonly') and empty($COURSE->groupmodeforce)) {
 114             $mform->disabledIf('groupingid', 'groupmode', 'eq', NOGROUPS);
 115
 116         } else if (!$mform->elementExists('groupmode') and $mform->elementExists('groupmembersonly')) {
 117             $mform->disabledIf('groupingid', 'groupmembersonly', 'notchecked');
 118
 119         } else if (!$mform->elementExists('groupmode') and !$mform->elementExists('groupmembersonly')) {
 120             // groupings have no use without groupmode or groupmembersonly
 121             if ($mform->elementExists('groupingid')) {
 122                 $mform->removeElement('groupingid');
 123             }
 124         }
 125     }
 126
 127     // form verification
 128     function validation($data, $files) {
 129         global $COURSE;
 130         $errors = parent::validation($data, $files);
 131
 132         $mform =& $this->_form;
 133
 134         $errors = array();
 135
 136         if ($mform->elementExists('name')) {
 137             $name = trim($data['name']);
 138             if ($name == '') {
 139                 $errors['name'] = get_string('required');
 140             }
 141         }
 142
 143         $grade_item = grade_item::fetch(array('itemtype'=>'mod', 'itemmodule'=>$data['modulename'],
 144                      'iteminstance'=>$data['instance'], 'itemnumber'=>0, 'courseid'=>$COURSE->id));
 145         if ($data['coursemodule']) {
 146             $cm = get_record('course_modules', 'id', $data['coursemodule']);
 147         } else {
 148             $cm = null;
 149         }
 150
 151         if ($mform->elementExists('cmidnumber')) {
 152             // verify the idnumber
 153             if (!grade_verify_idnumber($data['cmidnumber'], $COURSE->id, $grade_item, $cm)) {
 154                 $errors['cmidnumber'] = get_string('idnumbertaken');
 155             }
 156         }
 157
 158         return $errors;
 159     }
 160
 161     /**
 162      * Load in existing data as form defaults. Usually new entry defaults are stored directly in
 163      * form definition (new entry form); this function is used to load in data where values
 164      * already exist and data is being edited (edit entry form).
 165      *
 166      * @param mixed $default_values object or array of default values
 167      */
 168     function set_data($default_values) {
 169         if (is_object($default_values)) {
 170             $default_values = (array)$default_values;
 171         }
 172         $this->data_preprocessing($default_values);
 173         parent::set_data($default_values); //never slashed for moodleform_mod
 174     }
 175
 176     /**
 177      * Adds all the standard elements to a form to edit the settings for an activity module.
 178      *
 179      * @param mixed array or object describing supported features - groups, groupings, groupmembersonly, etc.
 180      */
 181     function standard_coursemodule_elements($features=null){
 182         global $COURSE, $CFG;
 183         $mform =& $this->_form;
 184
 185         // deal with legacy $supportgroups param
 186         if ($features === true or $features === false) {
 187             $groupmode = $features;
 188             $this->_features = new object();
 189             $this->_features->groups = $groupmode;
 190
 191         } else if (is_array($features)) {
 192             $this->_features = (object)$features;
 193
 194         } else if (empty($features)) {
 195             $this->_features = new object();
 196
 197         } else {
 198             $this->_features = $features;
 199         }
 200
 201         if (!isset($this->_features->groups)) {
 202             $this->_features->groups = true;
 203         }
 204
 205         if (!isset($this->_features->groupings)) {
 206             $this->_features->groupings = false;
 207         }
 208
 209         if (!isset($this->_features->groupmembersonly)) {
 210             $this->_features->groupmembersonly = false;
 211         }
 212
 213         if (!isset($this->_features->outcomes)) {
 214             $this->_features->outcomes = true;
 215         }
 216
 217         if (!isset($this->_features->gradecat)) {
 218             $this->_features->gradecat = true;
 219         }
 220
 221         if (!isset($this->_features->idnumber)) {
 222             $this->_features->idnumber = true;
 223         }
 224
 225         $outcomesused = false;
 226         if (!empty($CFG->enableoutcomes) and $this->_features->outcomes) {
 227             if ($outcomes = grade_outcome::fetch_all_available($COURSE->id)) {
 228                 $outcomesused = true;
 229                 $mform->addElement('header', 'modoutcomes', get_string('outcomes', 'grades'));
 230                 foreach($outcomes as $outcome) {
 231                     $mform->addElement('advcheckbox', 'outcome_'.$outcome->id, $outcome->get_name());
 232                 }
 233             }
 234         }
 235
 236         $mform->addElement('header', 'modstandardelshdr', get_string('modstandardels', 'form'));
 237         if ($this->_features->groups) {
 238             $options = array(NOGROUPS       => get_string('groupsnone'),
 239                              SEPARATEGROUPS => get_string('groupsseparate'),
 240                              VISIBLEGROUPS  => get_string('groupsvisible'));
 241             $mform->addElement('select', 'groupmode', get_string('groupmode'), $options, NOGROUPS);
 242             $mform->setHelpButton('groupmode', array('groupmode', get_string('groupmode')));
 243         }
 244
 245         if (!empty($CFG->enablegroupings)) {
 246             if ($this->_features->groupings or $this->_features->groupmembersonly) {
 247                 //groupings selector - used for normal grouping mode or also when restricting access with groupmembersonly
 248                 $options = array();
 249                 $options[0] = get_string('none');
 250                 if ($groupings = get_records('groupings', 'courseid', $COURSE->id)) {
 251                     foreach ($groupings as $grouping) {
 252                         $options[$grouping->id] = format_string($grouping->name);
 253                     }
 254                 }
 255                 $mform->addElement('select', 'groupingid', get_string('grouping', 'group'), $options);
 256                 $mform->setHelpButton('groupingid', array('grouping', get_string('grouping', 'group')));
 257                 $mform->setAdvanced('groupingid');
 258             }
 259
 260             if ($this->_features->groupmembersonly) {
 261                 $mform->addElement('checkbox', 'groupmembersonly', get_string('groupmembersonly', 'group'));
 262                 $mform->setHelpButton('groupmembersonly', array('groupmembersonly', get_string('groupmembersonly', 'group')));
 263                 $mform->setAdvanced('groupmembersonly');
 264             }
 265         }
 266
 267         $mform->addElement('modvisible', 'visible', get_string('visible'));
 268
 269         if ($this->_features->idnumber) {
 270             $mform->addElement('text', 'cmidnumber', get_string('idnumbermod'));
 271             $mform->setHelpButton('cmidnumber', array('cmidnumber', get_string('idnumbermod')), true);
 272         }
 273
 274         if ($this->_features->gradecat) {
 275             $categories = grade_get_categories_menu($COURSE->id, $outcomesused);
 276             $mform->addElement('select', 'gradecat', get_string('gradecategory', 'grades'), $categories);
 277         }
 278
 279         $this->standard_hidden_coursemodule_elements();
 280     }
 281
 282     function standard_hidden_coursemodule_elements(){
 283         $mform =& $this->_form;
 284         $mform->addElement('hidden', 'course', 0);
 285         $mform->setType('course', PARAM_INT);
 286
 287         $mform->addElement('hidden', 'coursemodule', 0);
 288         $mform->setType('coursemodule', PARAM_INT);
 289
 290         $mform->addElement('hidden', 'section', 0);
 291         $mform->setType('section', PARAM_INT);
 292
 293         $mform->addElement('hidden', 'module', 0);
 294         $mform->setType('module', PARAM_INT);
 295
 296         $mform->addElement('hidden', 'modulename', '');
 297         $mform->setType('modulename', PARAM_SAFEDIR);
 298
 299         $mform->addElement('hidden', 'instance', 0);
 300         $mform->setType('instance', PARAM_INT);
 301
 302         $mform->addElement('hidden', 'add', 0);
 303         $mform->setType('add', PARAM_ALPHA);
 304
 305         $mform->addElement('hidden', 'update', 0);
 306         $mform->setType('update', PARAM_INT);
 307
 308         $mform->addElement('hidden', 'return', 0);
 309         $mform->setType('return', PARAM_BOOL);
 310     }
 311
 312     /**
 313      * Overriding formslib's add_action_buttons() method, to add an extra submit "save changes and return" button.
 314      *
 315      * @param bool $cancel show cancel button
 316      * @param string $submitlabel null means default, false means none, string is label text
 317      * @param string $submit2label  null means default, false means none, string is label text
 318      * @return void
 319      */
 320     function add_action_buttons($cancel=true, $submitlabel=null, $submit2label=null) {
 321         if (is_null($submitlabel)) {
 322             $submitlabel = get_string('savechangesanddisplay');
 323         }
 324
 325         if (is_null($submit2label)) {
 326             $submit2label = get_string('savechangesandreturntocourse');
 327         }
 328
 329         $mform =& $this->_form;
 330
 331         // elements in a row need a group
 332         $buttonarray = array();
 333
 334         if ($submit2label !== false) {
 335             $buttonarray[] = &$mform->createElement('submit', 'submitbutton2', $submit2label);
 336         }
 337
 338         if ($submitlabel !== false) {
 339             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submitlabel);
 340         }
 341
 342         if ($cancel) {
 343             $buttonarray[] = &$mform->createElement('cancel');
 344         }
 345
 346         $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
 347         $mform->setType('buttonar', PARAM_RAW);
 348         $mform->closeHeaderBefore('buttonar');
 349     }
 350 }
 351
 352 ?>