/course/edit_form.php
PHP | 340 lines | 264 code | 55 blank | 21 comment | 35 complexity | 6fa8ee3a820e718b031951d9730ba197 MD5 | raw file
Possible License(s): LGPL-2.1, AGPL-3.0, MPL-2.0-no-copyleft-exception, GPL-3.0, Apache-2.0, BSD-3-Clause
- <?php
- defined('MOODLE_INTERNAL') || die;
- require_once($CFG->libdir.'/formslib.php');
- require_once($CFG->libdir.'/completionlib.php');
- class course_edit_form extends moodleform {
- protected $course;
- protected $context;
- function definition() {
- global $USER, $CFG, $DB;
- $mform = $this->_form;
- $course = $this->_customdata['course']; // this contains the data of this form
- $category = $this->_customdata['category'];
- $editoroptions = $this->_customdata['editoroptions'];
- $returnto = $this->_customdata['returnto'];
- $systemcontext = get_context_instance(CONTEXT_SYSTEM);
- $categorycontext = get_context_instance(CONTEXT_COURSECAT, $category->id);
- if (!empty($course->id)) {
- $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
- $context = $coursecontext;
- } else {
- $coursecontext = null;
- $context = $categorycontext;
- }
- $courseconfig = get_config('moodlecourse');
- $this->course = $course;
- $this->context = $context;
- /// form definition with new course defaults
- //--------------------------------------------------------------------------------
- $mform->addElement('header','general', get_string('general', 'form'));
- $mform->addElement('hidden', 'returnto', null);
- $mform->setType('returnto', PARAM_ALPHANUM);
- $mform->setConstant('returnto', $returnto);
- // verify permissions to change course category or keep current
- if (empty($course->id)) {
- if (has_capability('moodle/course:create', $categorycontext)) {
- $displaylist = array();
- $parentlist = array();
- make_categories_list($displaylist, $parentlist, 'moodle/course:create');
- $mform->addElement('select', 'category', get_string('category'), $displaylist);
- $mform->addHelpButton('category', 'category');
- $mform->setDefault('category', $category->id);
- } else {
- $mform->addElement('hidden', 'category', null);
- $mform->setType('category', PARAM_INT);
- $mform->setConstant('category', $category->id);
- }
- } else {
- if (has_capability('moodle/course:changecategory', $coursecontext)) {
- $displaylist = array();
- $parentlist = array();
- make_categories_list($displaylist, $parentlist, 'moodle/course:create');
- if (!isset($displaylist[$course->category])) {
- //always keep current
- $displaylist[$course->category] = format_string($DB->get_field('course_categories', 'name', array('id'=>$course->category)));
- }
- $mform->addElement('select', 'category', get_string('category'), $displaylist);
- $mform->addHelpButton('category', 'category');
- } else {
- //keep current
- $mform->addElement('hidden', 'category', null);
- $mform->setType('category', PARAM_INT);
- $mform->setConstant('category', $course->category);
- }
- }
- $mform->addElement('text','fullname', get_string('fullnamecourse'),'maxlength="254" size="50"');
- $mform->addHelpButton('fullname', 'fullnamecourse');
- $mform->addRule('fullname', get_string('missingfullname'), 'required', null, 'client');
- $mform->setType('fullname', PARAM_MULTILANG);
- if (!empty($course->id) and !has_capability('moodle/course:changefullname', $coursecontext)) {
- $mform->hardFreeze('fullname');
- $mform->setConstant('fullname', $course->fullname);
- }
- $mform->addElement('text', 'shortname', get_string('shortnamecourse'), 'maxlength="100" size="20"');
- $mform->addHelpButton('shortname', 'shortnamecourse');
- $mform->addRule('shortname', get_string('missingshortname'), 'required', null, 'client');
- $mform->setType('shortname', PARAM_MULTILANG);
- if (!empty($course->id) and !has_capability('moodle/course:changeshortname', $coursecontext)) {
- $mform->hardFreeze('shortname');
- $mform->setConstant('shortname', $course->shortname);
- }
- $mform->addElement('text','idnumber', get_string('idnumbercourse'),'maxlength="100" size="10"');
- $mform->addHelpButton('idnumber', 'idnumbercourse');
- $mform->setType('idnumber', PARAM_RAW);
- if (!empty($course->id) and !has_capability('moodle/course:changeidnumber', $coursecontext)) {
- $mform->hardFreeze('idnumber');
- $mform->setConstants('idnumber', $course->idnumber);
- }
- $mform->addElement('editor','summary_editor', get_string('coursesummary'), null, $editoroptions);
- $mform->addHelpButton('summary_editor', 'coursesummary');
- $mform->setType('summary_editor', PARAM_RAW);
- if (!empty($course->id) and !has_capability('moodle/course:changesummary', $coursecontext)) {
- $mform->hardFreeze('summary_editor');
- }
- $courseformats = get_plugin_list('format');
- $formcourseformats = array();
- foreach ($courseformats as $courseformat => $formatdir) {
- $formcourseformats[$courseformat] = get_string('pluginname', "format_$courseformat");
- }
- $mform->addElement('select', 'format', get_string('format'), $formcourseformats);
- $mform->addHelpButton('format', 'format');
- $mform->setDefault('format', $courseconfig->format);
- $mform->addElement('select', 'coursedisplay', get_string('coursedisplay'),
- array(COURSE_DISPLAY_SINGLEPAGE => get_string('coursedisplay_single'),
- COURSE_DISPLAY_MULTIPAGE => get_string('coursedisplay_multi')));
- $mform->addHelpButton('coursedisplay', 'coursedisplay');
- $mform->setDefault('coursedisplay', COURSE_DISPLAY_SINGLEPAGE);
- for ($i = 0; $i <= $courseconfig->maxsections; $i++) {
- $sectionmenu[$i] = "$i";
- }
- $mform->addElement('select', 'numsections', get_string('numberweeks'), $sectionmenu);
- $mform->setDefault('numsections', $courseconfig->numsections);
- $mform->addElement('date_selector', 'startdate', get_string('startdate'));
- $mform->addHelpButton('startdate', 'startdate');
- $mform->setDefault('startdate', time() + 3600 * 24);
- $choices = array();
- $choices['0'] = get_string('hiddensectionscollapsed');
- $choices['1'] = get_string('hiddensectionsinvisible');
- $mform->addElement('select', 'hiddensections', get_string('hiddensections'), $choices);
- $mform->addHelpButton('hiddensections', 'hiddensections');
- $mform->setDefault('hiddensections', $courseconfig->hiddensections);
- $options = range(0, 10);
- $mform->addElement('select', 'newsitems', get_string('newsitemsnumber'), $options);
- $mform->addHelpButton('newsitems', 'newsitemsnumber');
- $mform->setDefault('newsitems', $courseconfig->newsitems);
- $mform->addElement('selectyesno', 'showgrades', get_string('showgrades'));
- $mform->addHelpButton('showgrades', 'showgrades');
- $mform->setDefault('showgrades', $courseconfig->showgrades);
- $mform->addElement('selectyesno', 'showreports', get_string('showreports'));
- $mform->addHelpButton('showreports', 'showreports');
- $mform->setDefault('showreports', $courseconfig->showreports);
- $choices = get_max_upload_sizes($CFG->maxbytes);
- $mform->addElement('select', 'maxbytes', get_string('maximumupload'), $choices);
- $mform->addHelpButton('maxbytes', 'maximumupload');
- $mform->setDefault('maxbytes', $courseconfig->maxbytes);
- if (!empty($course->legacyfiles) or !empty($CFG->legacyfilesinnewcourses)) {
- if (empty($course->legacyfiles)) {
- //0 or missing means no legacy files ever used in this course - new course or nobody turned on legacy files yet
- $choices = array('0'=>get_string('no'), '2'=>get_string('yes'));
- } else {
- $choices = array('1'=>get_string('no'), '2'=>get_string('yes'));
- }
- $mform->addElement('select', 'legacyfiles', get_string('courselegacyfiles'), $choices);
- $mform->addHelpButton('legacyfiles', 'courselegacyfiles');
- if (!isset($courseconfig->legacyfiles)) {
- // in case this was not initialised properly due to switching of $CFG->legacyfilesinnewcourses
- $courseconfig->legacyfiles = 0;
- }
- $mform->setDefault('legacyfiles', $courseconfig->legacyfiles);
- }
- if (!empty($CFG->allowcoursethemes)) {
- $themeobjects = get_list_of_themes();
- $themes=array();
- $themes[''] = get_string('forceno');
- foreach ($themeobjects as $key=>$theme) {
- if (empty($theme->hidefromselector)) {
- $themes[$key] = get_string('pluginname', 'theme_'.$theme->name);
- }
- }
- $mform->addElement('select', 'theme', get_string('forcetheme'), $themes);
- }
- //--------------------------------------------------------------------------------
- enrol_course_edit_form($mform, $course, $context);
- //--------------------------------------------------------------------------------
- $mform->addElement('header','', get_string('groups', 'group'));
- $choices = array();
- $choices[NOGROUPS] = get_string('groupsnone', 'group');
- $choices[SEPARATEGROUPS] = get_string('groupsseparate', 'group');
- $choices[VISIBLEGROUPS] = get_string('groupsvisible', 'group');
- $mform->addElement('select', 'groupmode', get_string('groupmode', 'group'), $choices);
- $mform->addHelpButton('groupmode', 'groupmode', 'group');
- $mform->setDefault('groupmode', $courseconfig->groupmode);
- $choices = array();
- $choices['0'] = get_string('no');
- $choices['1'] = get_string('yes');
- $mform->addElement('select', 'groupmodeforce', get_string('groupmodeforce', 'group'), $choices);
- $mform->addHelpButton('groupmodeforce', 'groupmodeforce', 'group');
- $mform->setDefault('groupmodeforce', $courseconfig->groupmodeforce);
- //default groupings selector
- $options = array();
- $options[0] = get_string('none');
- $mform->addElement('select', 'defaultgroupingid', get_string('defaultgrouping', 'group'), $options);
- //--------------------------------------------------------------------------------
- $mform->addElement('header','', get_string('availability'));
- $choices = array();
- $choices['0'] = get_string('courseavailablenot');
- $choices['1'] = get_string('courseavailable');
- $mform->addElement('select', 'visible', get_string('availability'), $choices);
- $mform->addHelpButton('visible', 'availability');
- $mform->setDefault('visible', $courseconfig->visible);
- if (!has_capability('moodle/course:visibility', $context)) {
- $mform->hardFreeze('visible');
- if (!empty($course->id)) {
- $mform->setConstant('visible', $course->visible);
- } else {
- $mform->setConstant('visible', $category->visible);
- }
- }
- //--------------------------------------------------------------------------------
- $mform->addElement('header','', get_string('language'));
- $languages=array();
- $languages[''] = get_string('forceno');
- $languages += get_string_manager()->get_list_of_translations();
- $mform->addElement('select', 'lang', get_string('forcelanguage'), $languages);
- $mform->setDefault('lang', $courseconfig->lang);
- //--------------------------------------------------------------------------------
- if (completion_info::is_enabled_for_site()) {
- $mform->addElement('header','', get_string('progress','completion'));
- $mform->addElement('select', 'enablecompletion', get_string('completion','completion'),
- array(0=>get_string('completiondisabled','completion'), 1=>get_string('completionenabled','completion')));
- $mform->setDefault('enablecompletion', $courseconfig->enablecompletion);
- $mform->addElement('checkbox', 'completionstartonenrol', get_string('completionstartonenrol', 'completion'));
- $mform->setDefault('completionstartonenrol', $courseconfig->completionstartonenrol);
- $mform->disabledIf('completionstartonenrol', 'enablecompletion', 'eq', 0);
- } else {
- $mform->addElement('hidden', 'enablecompletion');
- $mform->setType('enablecompletion', PARAM_INT);
- $mform->setDefault('enablecompletion',0);
- $mform->addElement('hidden', 'completionstartonenrol');
- $mform->setType('completionstartonenrol', PARAM_INT);
- $mform->setDefault('completionstartonenrol',0);
- }
- /// customizable role names in this course
- //--------------------------------------------------------------------------------
- $mform->addElement('header','rolerenaming', get_string('rolerenaming'));
- $mform->addHelpButton('rolerenaming', 'rolerenaming');
- if ($roles = get_all_roles()) {
- if ($coursecontext) {
- $roles = role_fix_names($roles, $coursecontext, ROLENAME_ALIAS_RAW);
- }
- $assignableroles = get_roles_for_contextlevels(CONTEXT_COURSE);
- foreach ($roles as $role) {
- $mform->addElement('text', 'role_'.$role->id, get_string('yourwordforx', '', $role->name));
- if (isset($role->localname)) {
- $mform->setDefault('role_'.$role->id, $role->localname);
- }
- $mform->setType('role_'.$role->id, PARAM_TEXT);
- if (!in_array($role->id, $assignableroles)) {
- $mform->setAdvanced('role_'.$role->id);
- }
- }
- }
- //--------------------------------------------------------------------------------
- $this->add_action_buttons();
- //--------------------------------------------------------------------------------
- $mform->addElement('hidden', 'id', null);
- $mform->setType('id', PARAM_INT);
- /// finally set the current form data
- //--------------------------------------------------------------------------------
- $this->set_data($course);
- }
- function definition_after_data() {
- global $DB;
- $mform = $this->_form;
- // add available groupings
- if ($courseid = $mform->getElementValue('id') and $mform->elementExists('defaultgroupingid')) {
- $options = array();
- if ($groupings = $DB->get_records('groupings', array('courseid'=>$courseid))) {
- foreach ($groupings as $grouping) {
- $options[$grouping->id] = format_string($grouping->name);
- }
- }
- $gr_el =& $mform->getElement('defaultgroupingid');
- $gr_el->load($options);
- }
- }
- /// perform some extra moodle validation
- function validation($data, $files) {
- global $DB, $CFG;
- $errors = parent::validation($data, $files);
- if ($foundcourses = $DB->get_records('course', array('shortname'=>$data['shortname']))) {
- if (!empty($data['id'])) {
- unset($foundcourses[$data['id']]);
- }
- if (!empty($foundcourses)) {
- foreach ($foundcourses as $foundcourse) {
- $foundcoursenames[] = $foundcourse->fullname;
- }
- $foundcoursenamestring = implode(',', $foundcoursenames);
- $errors['shortname']= get_string('shortnametaken', '', $foundcoursenamestring);
- }
- }
- $errors = array_merge($errors, enrol_course_edit_validation($data, $this->context));
- return $errors;
- }
- }