319bdac5c5b9ce6f5c74842cf56731ece66a738c
[moodle.git] / course / edit_form.php
1 <?php
3 defined('MOODLE_INTERNAL') || die;
5 require_once($CFG->libdir.'/formslib.php');
6 require_once($CFG->libdir.'/completionlib.php');
8 class course_edit_form extends moodleform {
9     protected $course;
10     protected $context;
12     function definition() {
13         global $USER, $CFG, $DB;
15         $mform    = $this->_form;
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'];
22         $systemcontext   = get_context_instance(CONTEXT_SYSTEM);
23         $categorycontext = get_context_instance(CONTEXT_COURSECAT, $category->id);
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         }
33         $courseconfig = get_config('moodlecourse');
35         $this->course  = $course;
36         $this->context = $context;
38 /// form definition with new course defaults
39 //--------------------------------------------------------------------------------
40         $mform->addElement('header','general', get_string('general', 'form'));
42         $mform->addElement('hidden', 'returnto', null);
43         $mform->setType('returnto', PARAM_ALPHANUM);
44         $mform->setConstant('returnto', $returnto);
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         }
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         }
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         }
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         }
106         $mform->addElement('editor','summary_editor', get_string('coursesummary'), null, $editoroptions);
107         $mform->addHelpButton('summary_editor', 'coursesummary');
108         $mform->setType('summary_editor', PARAM_RAW);
110         if (!empty($course->id) and !has_capability('moodle/course:changesummary', $coursecontext)) {
111             $mform->hardFreeze('summary_editor');
112         }
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);
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);
129         for ($i = 0; $i <= $courseconfig->maxsections; $i++) {
130             $sectionmenu[$i] = "$i";
131         }
132         $mform->addElement('select', 'numsections', get_string('numberweeks'), $sectionmenu);
133         $mform->setDefault('numsections', $courseconfig->numsections);
135         $mform->addElement('date_selector', 'startdate', get_string('startdate'));
136         $mform->addHelpButton('startdate', 'startdate');
137         $mform->setDefault('startdate', time() + 3600 * 24);
139         $choices = array();
140         $choices['0'] = get_string('hiddensectionscollapsed');
141         $choices['1'] = get_string('hiddensectionsinvisible');
142         $mform->addElement('select', 'hiddensections', get_string('hiddensections'), $choices);
143         $mform->addHelpButton('hiddensections', 'hiddensections');
144         $mform->setDefault('hiddensections', $courseconfig->hiddensections);
146         $options = range(0, 10);
147         $mform->addElement('select', 'newsitems', get_string('newsitemsnumber'), $options);
148         $mform->addHelpButton('newsitems', 'newsitemsnumber');
149         $mform->setDefault('newsitems', $courseconfig->newsitems);
151         $mform->addElement('selectyesno', 'showgrades', get_string('showgrades'));
152         $mform->addHelpButton('showgrades', 'showgrades');
153         $mform->setDefault('showgrades', $courseconfig->showgrades);
155         $mform->addElement('selectyesno', 'showreports', get_string('showreports'));
156         $mform->addHelpButton('showreports', 'showreports');
157         $mform->setDefault('showreports', $courseconfig->showreports);
159         $choices = get_max_upload_sizes($CFG->maxbytes, 0, 0, $course->maxbytes);
160         $mform->addElement('select', 'maxbytes', get_string('maximumupload'), $choices);
161         $mform->addHelpButton('maxbytes', 'maximumupload');
162         $mform->setDefault('maxbytes', $courseconfig->maxbytes);
164         if (!empty($course->legacyfiles) or !empty($CFG->legacyfilesinnewcourses)) {
165             if (empty($course->legacyfiles)) {
166                 //0 or missing means no legacy files ever used in this course - new course or nobody turned on legacy files yet
167                 $choices = array('0'=>get_string('no'), '2'=>get_string('yes'));
168             } else {
169                 $choices = array('1'=>get_string('no'), '2'=>get_string('yes'));
170             }
171             $mform->addElement('select', 'legacyfiles', get_string('courselegacyfiles'), $choices);
172             $mform->addHelpButton('legacyfiles', 'courselegacyfiles');
173             if (!isset($courseconfig->legacyfiles)) {
174                 // in case this was not initialised properly due to switching of $CFG->legacyfilesinnewcourses
175                 $courseconfig->legacyfiles = 0;
176             }
177             $mform->setDefault('legacyfiles', $courseconfig->legacyfiles);
178         }
180         if (!empty($CFG->allowcoursethemes)) {
181             $themeobjects = get_list_of_themes();
182             $themes=array();
183             $themes[''] = get_string('forceno');
184             foreach ($themeobjects as $key=>$theme) {
185                 if (empty($theme->hidefromselector)) {
186                     $themes[$key] = get_string('pluginname', 'theme_'.$theme->name);
187                 }
188             }
189             $mform->addElement('select', 'theme', get_string('forcetheme'), $themes);
190         }
192 //--------------------------------------------------------------------------------
193         enrol_course_edit_form($mform, $course, $context);
195 //--------------------------------------------------------------------------------
196         $mform->addElement('header','', get_string('groups', 'group'));
198         $choices = array();
199         $choices[NOGROUPS] = get_string('groupsnone', 'group');
200         $choices[SEPARATEGROUPS] = get_string('groupsseparate', 'group');
201         $choices[VISIBLEGROUPS] = get_string('groupsvisible', 'group');
202         $mform->addElement('select', 'groupmode', get_string('groupmode', 'group'), $choices);
203         $mform->addHelpButton('groupmode', 'groupmode', 'group');
204         $mform->setDefault('groupmode', $courseconfig->groupmode);
206         $choices = array();
207         $choices['0'] = get_string('no');
208         $choices['1'] = get_string('yes');
209         $mform->addElement('select', 'groupmodeforce', get_string('groupmodeforce', 'group'), $choices);
210         $mform->addHelpButton('groupmodeforce', 'groupmodeforce', 'group');
211         $mform->setDefault('groupmodeforce', $courseconfig->groupmodeforce);
213         //default groupings selector
214         $options = array();
215         $options[0] = get_string('none');
216         $mform->addElement('select', 'defaultgroupingid', get_string('defaultgrouping', 'group'), $options);
218 //--------------------------------------------------------------------------------
219         $mform->addElement('header','', get_string('availability'));
221         $choices = array();
222         $choices['0'] = get_string('courseavailablenot');
223         $choices['1'] = get_string('courseavailable');
224         $mform->addElement('select', 'visible', get_string('availability'), $choices);
225         $mform->addHelpButton('visible', 'availability');
226         $mform->setDefault('visible', $courseconfig->visible);
227         if (!has_capability('moodle/course:visibility', $context)) {
228             $mform->hardFreeze('visible');
229             if (!empty($course->id)) {
230                 $mform->setConstant('visible', $course->visible);
231             } else {
232                 $mform->setConstant('visible', $courseconfig->visible);
233             }
234         }
236 //--------------------------------------------------------------------------------
237         $mform->addElement('header','', get_string('language'));
239         $languages=array();
240         $languages[''] = get_string('forceno');
241         $languages += get_string_manager()->get_list_of_translations();
242         $mform->addElement('select', 'lang', get_string('forcelanguage'), $languages);
243         $mform->setDefault('lang', $courseconfig->lang);
245 //--------------------------------------------------------------------------------
246         if (completion_info::is_enabled_for_site()) {
247             $mform->addElement('header','', get_string('progress','completion'));
248             $mform->addElement('select', 'enablecompletion', get_string('completion','completion'),
249                 array(0=>get_string('completiondisabled','completion'), 1=>get_string('completionenabled','completion')));
250             $mform->setDefault('enablecompletion', $courseconfig->enablecompletion);
252             $mform->addElement('checkbox', 'completionstartonenrol', get_string('completionstartonenrol', 'completion'));
253             $mform->setDefault('completionstartonenrol', $courseconfig->completionstartonenrol);
254             $mform->disabledIf('completionstartonenrol', 'enablecompletion', 'eq', 0);
255         } else {
256             $mform->addElement('hidden', 'enablecompletion');
257             $mform->setType('enablecompletion', PARAM_INT);
258             $mform->setDefault('enablecompletion',0);
260             $mform->addElement('hidden', 'completionstartonenrol');
261             $mform->setType('completionstartonenrol', PARAM_INT);
262             $mform->setDefault('completionstartonenrol',0);
263         }
265 /// customizable role names in this course
266 //--------------------------------------------------------------------------------
267         $mform->addElement('header','rolerenaming', get_string('rolerenaming'));
268         $mform->addHelpButton('rolerenaming', 'rolerenaming');
270         if ($roles = get_all_roles()) {
271             if ($coursecontext) {
272                 $roles = role_fix_names($roles, $coursecontext, ROLENAME_ALIAS_RAW);
273             }
274             $assignableroles = get_roles_for_contextlevels(CONTEXT_COURSE);
275             foreach ($roles as $role) {
276                 $mform->addElement('text', 'role_'.$role->id, get_string('yourwordforx', '', $role->name));
277                 if (isset($role->localname)) {
278                     $mform->setDefault('role_'.$role->id, $role->localname);
279                 }
280                 $mform->setType('role_'.$role->id, PARAM_TEXT);
281                 if (!in_array($role->id, $assignableroles)) {
282                     $mform->setAdvanced('role_'.$role->id);
283                 }
284             }
285         }
287 //--------------------------------------------------------------------------------
288         $this->add_action_buttons();
289 //--------------------------------------------------------------------------------
290         $mform->addElement('hidden', 'id', null);
291         $mform->setType('id', PARAM_INT);
293 /// finally set the current form data
294 //--------------------------------------------------------------------------------
295         $this->set_data($course);
296     }
298     function definition_after_data() {
299         global $DB;
301         $mform = $this->_form;
303         // add available groupings
304         if ($courseid = $mform->getElementValue('id') and $mform->elementExists('defaultgroupingid')) {
305             $options = array();
306             if ($groupings = $DB->get_records('groupings', array('courseid'=>$courseid))) {
307                 foreach ($groupings as $grouping) {
308                     $options[$grouping->id] = format_string($grouping->name);
309                 }
310             }
311             $gr_el =& $mform->getElement('defaultgroupingid');
312             $gr_el->load($options);
313         }
314     }
317 /// perform some extra moodle validation
318     function validation($data, $files) {
319         global $DB, $CFG;
321         $errors = parent::validation($data, $files);
322         if ($foundcourses = $DB->get_records('course', array('shortname'=>$data['shortname']))) {
323             if (!empty($data['id'])) {
324                 unset($foundcourses[$data['id']]);
325             }
326             if (!empty($foundcourses)) {
327                 foreach ($foundcourses as $foundcourse) {
328                     $foundcoursenames[] = $foundcourse->fullname;
329                 }
330                 $foundcoursenamestring = implode(',', $foundcoursenames);
331                 $errors['shortname']= get_string('shortnametaken', '', $foundcoursenamestring);
332             }
333         }
335         $errors = array_merge($errors, enrol_course_edit_validation($data, $this->context));
337         return $errors;
338     }