course/edit_form.php

   1 <?php
   2
   3 defined('MOODLE_INTERNAL') || die;
   4
   5 require_once($CFG->libdir.'/formslib.php');
   6 require_once($CFG->libdir.'/completionlib.php');
   7
   8 class course_edit_form extends moodleform {
   9     protected $course;
  10     protected $context;
  11
  12     function definition() {
  13         global $USER, $CFG, $DB;
  14
  15         $mform    = $this->_form;
  16
  17         $course        = $this->_customdata['course']; // this contains the data of this form
  18         $category      = $this->_customdata['category'];
  19         $editoroptions = $this->_customdata['editoroptions'];
  20         $returnto = $this->_customdata['returnto'];
  21
  22         $systemcontext   = get_context_instance(CONTEXT_SYSTEM);
  23         $categorycontext = get_context_instance(CONTEXT_COURSECAT, $category->id);
  24
  25         if (!empty($course->id)) {
  26             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
  27             $context = $coursecontext;
  28         } else {
  29             $coursecontext = null;
  30             $context = $categorycontext;
  31         }
  32
  33         $courseconfig = get_config('moodlecourse');
  34
  35         $this->course  = $course;
  36         $this->context = $context;
  37
  38 /// form definition with new course defaults
  39 //--------------------------------------------------------------------------------
  40         $mform->addElement('header','general', get_string('general', 'form'));
  41
  42         $mform->addElement('hidden', 'returnto', null);
  43         $mform->setType('returnto', PARAM_ALPHANUM);
  44         $mform->setConstant('returnto', $returnto);
  45
  46         // verify permissions to change course category or keep current
  47         if (empty($course->id)) {
  48             if (has_capability('moodle/course:create', $categorycontext)) {
  49                 $displaylist = array();
  50                 $parentlist = array();
  51                 make_categories_list($displaylist, $parentlist, 'moodle/course:create');
  52                 $mform->addElement('select', 'category', get_string('category'), $displaylist);
  53                 $mform->addHelpButton('category', 'category');
  54                 $mform->setDefault('category', $category->id);
  55             } else {
  56                 $mform->addElement('hidden', 'category', null);
  57                 $mform->setType('category', PARAM_INT);
  58                 $mform->setConstant('category', $category->id);
  59             }
  60         } else {
  61             if (has_capability('moodle/course:changecategory', $coursecontext)) {
  62                 $displaylist = array();
  63                 $parentlist = array();
  64                 make_categories_list($displaylist, $parentlist, 'moodle/course:create');
  65                 if (!isset($displaylist[$course->category])) {
  66                     //always keep current
  67                     $displaylist[$course->category] = format_string($DB->get_field('course_categories', 'name', array('id'=>$course->category)));
  68                 }
  69                 $mform->addElement('select', 'category', get_string('category'), $displaylist);
  70                 $mform->addHelpButton('category', 'category');
  71             } else {
  72                 //keep current
  73                 $mform->addElement('hidden', 'category', null);
  74                 $mform->setType('category', PARAM_INT);
  75                 $mform->setConstant('category', $course->category);
  76             }
  77         }
  78
  79         $mform->addElement('text','fullname', get_string('fullnamecourse'),'maxlength="254" size="50"');
  80         $mform->addHelpButton('fullname', 'fullnamecourse');
  81         $mform->addRule('fullname', get_string('missingfullname'), 'required', null, 'client');
  82         $mform->setType('fullname', PARAM_MULTILANG);
  83         if (!empty($course->id) and !has_capability('moodle/course:changefullname', $coursecontext)) {
  84             $mform->hardFreeze('fullname');
  85             $mform->setConstant('fullname', $course->fullname);
  86         }
  87
  88         $mform->addElement('text', 'shortname', get_string('shortnamecourse'), 'maxlength="100" size="20"');
  89         $mform->addHelpButton('shortname', 'shortnamecourse');
  90         $mform->addRule('shortname', get_string('missingshortname'), 'required', null, 'client');
  91         $mform->setType('shortname', PARAM_MULTILANG);
  92         if (!empty($course->id) and !has_capability('moodle/course:changeshortname', $coursecontext)) {
  93             $mform->hardFreeze('shortname');
  94             $mform->setConstant('shortname', $course->shortname);
  95         }
  96
  97         $mform->addElement('text','idnumber', get_string('idnumbercourse'),'maxlength="100"  size="10"');
  98         $mform->addHelpButton('idnumber', 'idnumbercourse');
  99         $mform->setType('idnumber', PARAM_RAW);
 100         if (!empty($course->id) and !has_capability('moodle/course:changeidnumber', $coursecontext)) {
 101             $mform->hardFreeze('idnumber');
 102             $mform->setConstants('idnumber', $course->idnumber);
 103         }
 104
 105
 106         $mform->addElement('editor','summary_editor', get_string('coursesummary'), null, $editoroptions);
 107         $mform->addHelpButton('summary_editor', 'coursesummary');
 108         $mform->setType('summary_editor', PARAM_RAW);
 109
 110         if (!empty($course->id) and !has_capability('moodle/course:changesummary', $coursecontext)) {
 111             $mform->hardFreeze('summary_editor');
 112         }
 113
 114         $courseformats = get_plugin_list('format');
 115         $formcourseformats = array();
 116         foreach ($courseformats as $courseformat => $formatdir) {
 117             $formcourseformats[$courseformat] = get_string('pluginname', "format_$courseformat");
 118         }
 119         $mform->addElement('select', 'format', get_string('format'), $formcourseformats);
 120         $mform->addHelpButton('format', 'format');
 121         $mform->setDefault('format', $courseconfig->format);
 122
 123         $mform->addElement('select', 'coursedisplay', get_string('coursedisplay'),
 124             array(COURSE_DISPLAY_SINGLEPAGE => get_string('coursedisplay_single'),
 125                 COURSE_DISPLAY_MULTIPAGE => get_string('coursedisplay_multi')));
 126         $mform->addHelpButton('coursedisplay', 'coursedisplay');
 127         $mform->setDefault('coursedisplay', $courseconfig->coursedisplay);
 128
 129         $max = $courseconfig->maxsections;
 130         if (!isset($max) || !is_numeric($max)) {
 131             $max = 52;
 132         }
 133
 134         // Increase the number of sections combo box values if the user has increased the number of sections
 135         // using the icon on the course page beyond course 'maxsections' or course 'maxsections' has been
 136         // reduced below the number of sections already set for the course on the site administration course
 137         // defaults page.  This is so that the number of sections is not reduced leaving unintended orphaned
 138         // activities / resources.
 139         if (isset($course->numsections) && $course->numsections > $max) {
 140             $max = $course->numsections;
 141         }
 142         for ($i = 0; $i <= $max; $i++) {
 143             $sectionmenu[$i] = "$i";
 144         }
 145         $mform->addElement('select', 'numsections', get_string('numberweeks'), $sectionmenu);
 146         $mform->setDefault('numsections', $courseconfig->numsections);
 147
 148         $mform->addElement('date_selector', 'startdate', get_string('startdate'));
 149         $mform->addHelpButton('startdate', 'startdate');
 150         $mform->setDefault('startdate', time() + 3600 * 24);
 151
 152         $choices = array();
 153         $choices['0'] = get_string('hiddensectionscollapsed');
 154         $choices['1'] = get_string('hiddensectionsinvisible');
 155         $mform->addElement('select', 'hiddensections', get_string('hiddensections'), $choices);
 156         $mform->addHelpButton('hiddensections', 'hiddensections');
 157         $mform->setDefault('hiddensections', $courseconfig->hiddensections);
 158
 159         $options = range(0, 10);
 160         $mform->addElement('select', 'newsitems', get_string('newsitemsnumber'), $options);
 161         $mform->addHelpButton('newsitems', 'newsitemsnumber');
 162         $mform->setDefault('newsitems', $courseconfig->newsitems);
 163
 164         $mform->addElement('selectyesno', 'showgrades', get_string('showgrades'));
 165         $mform->addHelpButton('showgrades', 'showgrades');
 166         $mform->setDefault('showgrades', $courseconfig->showgrades);
 167
 168         $mform->addElement('selectyesno', 'showreports', get_string('showreports'));
 169         $mform->addHelpButton('showreports', 'showreports');
 170         $mform->setDefault('showreports', $courseconfig->showreports);
 171
 172         // Handle non-existing $course->maxbytes on course creation.
 173         $coursemaxbytes = !isset($course->maxbytes) ? null : $course->maxbytes;
 174
 175         // Let's prepare the maxbytes popup.
 176         $choices = get_max_upload_sizes($CFG->maxbytes, 0, 0, $coursemaxbytes);
 177         $mform->addElement('select', 'maxbytes', get_string('maximumupload'), $choices);
 178         $mform->addHelpButton('maxbytes', 'maximumupload');
 179         $mform->setDefault('maxbytes', $courseconfig->maxbytes);
 180
 181         if (!empty($course->legacyfiles) or !empty($CFG->legacyfilesinnewcourses)) {
 182             if (empty($course->legacyfiles)) {
 183                 //0 or missing means no legacy files ever used in this course - new course or nobody turned on legacy files yet
 184                 $choices = array('0'=>get_string('no'), '2'=>get_string('yes'));
 185             } else {
 186                 $choices = array('1'=>get_string('no'), '2'=>get_string('yes'));
 187             }
 188             $mform->addElement('select', 'legacyfiles', get_string('courselegacyfiles'), $choices);
 189             $mform->addHelpButton('legacyfiles', 'courselegacyfiles');
 190             if (!isset($courseconfig->legacyfiles)) {
 191                 // in case this was not initialised properly due to switching of $CFG->legacyfilesinnewcourses
 192                 $courseconfig->legacyfiles = 0;
 193             }
 194             $mform->setDefault('legacyfiles', $courseconfig->legacyfiles);
 195         }
 196
 197         if (!empty($CFG->allowcoursethemes)) {
 198             $themeobjects = get_list_of_themes();
 199             $themes=array();
 200             $themes[''] = get_string('forceno');
 201             foreach ($themeobjects as $key=>$theme) {
 202                 if (empty($theme->hidefromselector)) {
 203                     $themes[$key] = get_string('pluginname', 'theme_'.$theme->name);
 204                 }
 205             }
 206             $mform->addElement('select', 'theme', get_string('forcetheme'), $themes);
 207         }
 208
 209 //--------------------------------------------------------------------------------
 210         enrol_course_edit_form($mform, $course, $context);
 211
 212 //--------------------------------------------------------------------------------
 213         $mform->addElement('header', '', get_string('groupsettingsheader', 'group'));
 214
 215         $choices = array();
 216         $choices[NOGROUPS] = get_string('groupsnone', 'group');
 217         $choices[SEPARATEGROUPS] = get_string('groupsseparate', 'group');
 218         $choices[VISIBLEGROUPS] = get_string('groupsvisible', 'group');
 219         $mform->addElement('select', 'groupmode', get_string('groupmode', 'group'), $choices);
 220         $mform->addHelpButton('groupmode', 'groupmode', 'group');
 221         $mform->setDefault('groupmode', $courseconfig->groupmode);
 222
 223         $choices = array();
 224         $choices['0'] = get_string('no');
 225         $choices['1'] = get_string('yes');
 226         $mform->addElement('select', 'groupmodeforce', get_string('groupmodeforce', 'group'), $choices);
 227         $mform->addHelpButton('groupmodeforce', 'groupmodeforce', 'group');
 228         $mform->setDefault('groupmodeforce', $courseconfig->groupmodeforce);
 229
 230         //default groupings selector
 231         $options = array();
 232         $options[0] = get_string('none');
 233         $mform->addElement('select', 'defaultgroupingid', get_string('defaultgrouping', 'group'), $options);
 234
 235 //--------------------------------------------------------------------------------
 236         $mform->addElement('header','', get_string('availability'));
 237
 238         $choices = array();
 239         $choices['0'] = get_string('courseavailablenot');
 240         $choices['1'] = get_string('courseavailable');
 241         $mform->addElement('select', 'visible', get_string('availability'), $choices);
 242         $mform->addHelpButton('visible', 'availability');
 243         $mform->setDefault('visible', $courseconfig->visible);
 244         if (!has_capability('moodle/course:visibility', $context)) {
 245             $mform->hardFreeze('visible');
 246             if (!empty($course->id)) {
 247                 $mform->setConstant('visible', $course->visible);
 248             } else {
 249                 $mform->setConstant('visible', $courseconfig->visible);
 250             }
 251         }
 252
 253 //--------------------------------------------------------------------------------
 254         $mform->addElement('header','', get_string('language'));
 255
 256         $languages=array();
 257         $languages[''] = get_string('forceno');
 258         $languages += get_string_manager()->get_list_of_translations();
 259         $mform->addElement('select', 'lang', get_string('forcelanguage'), $languages);
 260         $mform->setDefault('lang', $courseconfig->lang);
 261
 262 //--------------------------------------------------------------------------------
 263         if (completion_info::is_enabled_for_site()) {
 264             $mform->addElement('header','', get_string('progress','completion'));
 265             $mform->addElement('select', 'enablecompletion', get_string('completion','completion'),
 266                 array(0=>get_string('completiondisabled','completion'), 1=>get_string('completionenabled','completion')));
 267             $mform->setDefault('enablecompletion', $courseconfig->enablecompletion);
 268
 269             $mform->addElement('advcheckbox', 'completionstartonenrol', get_string('completionstartonenrol', 'completion'));
 270             $mform->setDefault('completionstartonenrol', $courseconfig->completionstartonenrol);
 271             $mform->disabledIf('completionstartonenrol', 'enablecompletion', 'eq', 0);
 272         } else {
 273             $mform->addElement('hidden', 'enablecompletion');
 274             $mform->setType('enablecompletion', PARAM_INT);
 275             $mform->setDefault('enablecompletion',0);
 276
 277             $mform->addElement('hidden', 'completionstartonenrol');
 278             $mform->setType('completionstartonenrol', PARAM_INT);
 279             $mform->setDefault('completionstartonenrol',0);
 280         }
 281
 282 /// customizable role names in this course
 283 //--------------------------------------------------------------------------------
 284         $mform->addElement('header','rolerenaming', get_string('rolerenaming'));
 285         $mform->addHelpButton('rolerenaming', 'rolerenaming');
 286
 287         if ($roles = get_all_roles()) {
 288             if ($coursecontext) {
 289                 $roles = role_fix_names($roles, $coursecontext, ROLENAME_ALIAS_RAW);
 290             }
 291             $assignableroles = get_roles_for_contextlevels(CONTEXT_COURSE);
 292             foreach ($roles as $role) {
 293                 $mform->addElement('text', 'role_'.$role->id, get_string('yourwordforx', '', $role->name));
 294                 if (isset($role->localname)) {
 295                     $mform->setDefault('role_'.$role->id, $role->localname);
 296                 }
 297                 $mform->setType('role_'.$role->id, PARAM_TEXT);
 298                 if (!in_array($role->id, $assignableroles)) {
 299                     $mform->setAdvanced('role_'.$role->id);
 300                 }
 301             }
 302         }
 303
 304 //--------------------------------------------------------------------------------
 305         $this->add_action_buttons();
 306 //--------------------------------------------------------------------------------
 307         $mform->addElement('hidden', 'id', null);
 308         $mform->setType('id', PARAM_INT);
 309
 310 /// finally set the current form data
 311 //--------------------------------------------------------------------------------
 312         $this->set_data($course);
 313     }
 314
 315     function definition_after_data() {
 316         global $DB;
 317
 318         $mform = $this->_form;
 319
 320         // add available groupings
 321         if ($courseid = $mform->getElementValue('id') and $mform->elementExists('defaultgroupingid')) {
 322             $options = array();
 323             if ($groupings = $DB->get_records('groupings', array('courseid'=>$courseid))) {
 324                 foreach ($groupings as $grouping) {
 325                     $options[$grouping->id] = format_string($grouping->name);
 326                 }
 327             }
 328             $gr_el =& $mform->getElement('defaultgroupingid');
 329             $gr_el->load($options);
 330         }
 331     }
 332
 333
 334 /// perform some extra moodle validation
 335     function validation($data, $files) {
 336         global $DB, $CFG;
 337
 338         $errors = parent::validation($data, $files);
 339         if ($foundcourses = $DB->get_records('course', array('shortname'=>$data['shortname']))) {
 340             if (!empty($data['id'])) {
 341                 unset($foundcourses[$data['id']]);
 342             }
 343             if (!empty($foundcourses)) {
 344                 foreach ($foundcourses as $foundcourse) {
 345                     $foundcoursenames[] = $foundcourse->fullname;
 346                 }
 347                 $foundcoursenamestring = implode(',', $foundcoursenames);
 348                 $errors['shortname']= get_string('shortnametaken', '', $foundcoursenamestring);
 349             }
 350         }
 351
 352         $errors = array_merge($errors, enrol_course_edit_validation($data, $this->context));
 353
 354         return $errors;
 355     }
 356 }
 357