edit_form.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * @package local
 * @subpackage simple_course_creator
 * @copyright  2019 Queen Mary University of London
 * @author     Shubhendra R Doiphode <doiphode.sunny@gmail.com>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die;

require_once($CFG->libdir . '/formslib.php');
require_once($CFG->libdir . '/completionlib.php');

$categoryid = optional_param('category', '0', PARAM_INT); // Course category - can be changed in edit form.
$url = new moodle_url($CFG->wwwroot . '/local/simple_course_creator/view.php', array('category' => $categoryid));
$PAGE->set_url($url);

/**
 * The form for handling editing a course.
 */
class course_edit_form extends moodleform
{
    protected $course;
    protected $context;

    /**
     * Form definition.
     */
    public function definition() {

        global $CFG, $PAGE, $DB;

        $arrsectodisp = $DB->get_records('config_plugins', array('plugin' => 'local_simple_course_creator'));

        $sectodisp = array();

        foreach ($arrsectodisp as $keysectodisp) {
            $sectodisp[$keysectodisp->name] = $keysectodisp->value;
        }

        $GLOBALS['sectodisp'] = $sectodisp;

        $mform = $this->_form;
        $PAGE->requires->yui_module('moodle-course-formatchooser', 'M.course.init_formatchooser',
            array(array('formid' => $mform->getAttribute('id'))));

        $course = $this->_customdata['course'];          // This contains the data of this form.
        $category = $this->_customdata['category'];
        $returnto = $this->_customdata['returnto'];
        $returnurl = $this->_customdata['returnurl'];

        $systemcontext = context_system::instance();
        $categorycontext = context_coursecat::instance($category->id);

        if (!empty($course->id)) {
            $coursecontext = context_course::instance($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);

        $mform->addElement('hidden', 'returnurl', null);
        $mform->setType('returnurl', PARAM_LOCALURL);
        $mform->setConstant('returnurl', $returnurl);

        $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_TEXT);
        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_TEXT);
        if (!empty($course->id) and !has_capability('moodle/course:changeshortname', $coursecontext)) {
            $mform->hardFreeze('shortname');
            $mform->setConstant('shortname', $course->shortname);
        }

        // Verify permissions to change course category or keep current.
        if ($sectodisp["coursecategory"] != 1) {
            $mform->addElement('html', '<div style="display:none">');
        }

        if (empty($course->id)) {
            if (has_capability('moodle/course:create', $categorycontext)) {
                $displaylist = core_course_category::make_categories_list('moodle/course:create');
                $mform->addElement('select', 'category', get_string('coursecategory'), $displaylist);
                $mform->addHelpButton('category', 'coursecategory');
                $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 = core_course_category::make_categories_list('moodle/course:changecategory');
                if (!isset($displaylist[$course->category])) {
                    // Always keep current.
                    $displaylist[$course->category] = core_course_category::get($course->category, MUST_EXIST, true)
                        ->get_formatted_name();
                }
                $mform->addElement('select', 'category', get_string('coursecategory'), $displaylist);
                $mform->addHelpButton('category', 'coursecategory');
            } else {
                // Keep current.
                $mform->addElement('hidden', 'category', null);
                $mform->setType('category', PARAM_INT);
                $mform->setConstant('category', $course->category);
            }
        }
        if ($sectodisp["coursecategory"] != 1) {
            $mform->addElement('html', '</div>');
        }

        $choices = array();
        $choices['0'] = get_string('hide');
        $choices['1'] = get_string('show');

        if ($sectodisp["coursevisibility"] == 1) {
            $mform->addElement('select', 'visible', get_string('coursevisibility'), $choices);
            $mform->addHelpButton('visible', 'coursevisibility');
            $mform->setDefault('visible', $courseconfig->visible);
            if (!empty($course->id)) {
                if (!has_capability('moodle/course:visibility', $coursecontext)) {
                    $mform->hardFreeze('visible');
                    $mform->setConstant('visible', $course->visible);
                }
            } else {
                if (!guess_if_creator_will_have_course_capability('moodle/course:visibility', $categorycontext)) {
                    $mform->hardFreeze('visible');
                    $mform->setConstant('visible', $courseconfig->visible);
                }
            }
        }

        $mform->addElement('date_time_selector', 'startdate', get_string('startdate'));
        $mform->addHelpButton('startdate', 'startdate');

        $date = (new DateTime())->setTimestamp(usergetmidnight(time()));
        $date->modify('+1 day');
        $mform->setDefault('startdate', $date->getTimestamp());

        $mform->addElement('date_time_selector', 'enddate', get_string('enddate'), array('optional' => true));
        $mform->addHelpButton('enddate', 'enddate');

        if ($sectodisp["idnumbercourse"] == 1) {
            $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);
            }
        }

        // Description.
        if ($sectodisp["description"] == 1) {
            if ($sectodisp["description"] == 1) {

                $editoroptions ='';
                $mform->addElement('header', 'descriptionhdr', get_string('description'));
                $mform->setExpanded('descriptionhdr');

                $mform->addElement('editor', 'summary_editor', get_string('coursesummary'), null, $editoroptions);
                $mform->addHelpButton('summary_editor', 'coursesummary');
                $mform->setType('summary_editor', PARAM_RAW);
                $summaryfields = 'summary_editor';

                if ($overviewfilesoptions = course_overviewfiles_options($course)) {
                    $mform->addElement('filemanager', 'overviewfiles_filemanager', get_string('courseoverviewfiles'), null, $overviewfilesoptions);
                    $mform->addHelpButton('overviewfiles_filemanager', 'courseoverviewfiles');
                    $summaryfields .= ',overviewfiles_filemanager';
                }

                if (!empty($course->id) and !has_capability('moodle/course:changesummary', $coursecontext)) {
                    // Remove the description header it does not contain anything any more.
                    $mform->removeElement('descriptionhdr');
                    $mform->hardFreeze($summaryfields);
                }
            }
        }

        // Course format.

        $courseformats = get_sorted_course_formats(true);
        $formcourseformats = array();
        foreach ($courseformats as $courseformat) {
            $formcourseformats[$courseformat] = get_string('pluginname', "format_$courseformat");
        }
        if (isset($course->format)) {
            $course->format = course_get_format($course)->get_format(); // Replace with default if not found.
            if (!in_array($course->format, $courseformats)) {
                // This format is disabled. Still display it in the dropdown.
                $formcourseformats[$course->format] = get_string('withdisablednote', 'moodle',
                    get_string('pluginname', 'format_' . $course->format));
            }
        }

        if ($sectodisp["type_format"] == 1) {
            $mform->addElement('header', 'courseformathdr', get_string('type_format', 'plugin'));
            $mform->addElement('select', 'format', get_string('format'), $formcourseformats);
            $mform->addHelpButton('format', 'format');
            $mform->setDefault('format', $courseconfig->format);

            // Button to update format-specific options on format change (will be hidden by JavaScript).
            $mform->registerNoSubmitButton('updatecourseformat');
            $mform->addElement('submit', 'updatecourseformat', get_string('courseformatudpate'));
            // Just a placeholder for the course format options.
            $mform->addElement('hidden', 'addcourseformatoptionshere');
            $mform->setType('addcourseformatoptionshere', PARAM_BOOL);
        } else {
            $mform->addElement('html', '<div style="display:none">');
            $mform->addElement('select', 'format', get_string('format'), $formcourseformats);
            $mform->addHelpButton('format', 'format');
            $mform->setDefault('format', $courseconfig->format);

            // Button to update format-specific options on format change (will be hidden by JavaScript).
            $mform->registerNoSubmitButton('updatecourseformat');
            $mform->addElement('submit', 'updatecourseformat', get_string('courseformatudpate'));
            // Just a placeholder for the course format options.
            $mform->addElement('hidden', 'addcourseformatoptionshere');
            $mform->setType('addcourseformatoptionshere', PARAM_BOOL);
            $mform->addElement('html', '</div>');
        }

        // Appearance.

        if ($sectodisp["appearance"] != 1) {
            $mform->addElement('html', '<div style="display:none">');
        } else {
            $mform->addElement('header', 'appearancehdr', get_string('appearance'));
        }
        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);
        }

        $languages = array();
        $languages[''] = get_string('forceno');
        $languages += get_string_manager()->get_list_of_translations();
        if ((empty($course->id) && guess_if_creator_will_have_course_capability('moodle/course:setforcedlanguage', $categorycontext))
            || (!empty($course->id) && has_capability('moodle/course:setforcedlanguage', $coursecontext))) {
            $mform->addElement('select', 'lang', get_string('forcelanguage'), $languages);
            $mform->setDefault('lang', $courseconfig->lang);
        }

        // Multi-Calendar Support - see MDL-18375.
        $calendartypes = \core_calendar\type_factory::get_list_of_calendar_types();
        // We do not want to show this option unless there is more than one calendar type to display.
        if (count($calendartypes) > 1) {
            $calendars = array();
            $calendars[''] = get_string('forceno');
            $calendars += $calendartypes;
            $mform->addElement('select', 'calendartype', get_string('forcecalendartype', 'calendar'), $calendars);
        }

        $options = range(0, 10);
        $mform->addElement('select', 'newsitems', get_string('newsitemsnumber'), $options);
        $courseconfig = get_config('moodlecourse');
        $mform->setDefault('newsitems', $courseconfig->newsitems);
        $mform->addHelpButton('newsitems', 'newsitemsnumber');

        $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);

        if ($sectodisp["appearance"] != 1) {
            $mform->addElement('html', '</div>');
        }

        // Files and uploads.
        if ($sectodisp["filesanduploads"] == 1) {
            $mform->addElement('header', 'filehdr', get_string('filesanduploads'));

            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);
            }

            // Handle non-existing $course->maxbytes on course creation.
            $coursemaxbytes = !isset($course->maxbytes) ? null : $course->maxbytes;

            // Let's prepare the maxbytes popup.
            $choices = get_max_upload_sizes($CFG->maxbytes, 0, 0, $coursemaxbytes);
            $mform->addElement('select', 'maxbytes', get_string('maximumupload'), $choices);
            $mform->addHelpButton('maxbytes', 'maximumupload');
            $mform->setDefault('maxbytes', $courseconfig->maxbytes);
        }

        // Completion tracking.
        if ($sectodisp["completion"] == 1) {
            if (completion_info::is_enabled_for_site()) {
                $mform->addElement('header', 'completionhdr', get_string('completion', 'completion'));
                $mform->addElement('selectyesno', 'enablecompletion', get_string('enablecompletion', 'completion'));
                $mform->setDefault('enablecompletion', $courseconfig->enablecompletion);
                $mform->addHelpButton('enablecompletion', 'enablecompletion', 'completion');
            } else {
                $mform->addElement('hidden', 'enablecompletion');
                $mform->setType('enablecompletion', PARAM_INT);
                $mform->setDefault('enablecompletion', 0);
            }
        }

        enrol_course_edit_form($mform, $course, $context);

        // GROUPS!
        if ($sectodisp["groups"] == 1) {
            $mform->addElement('header', 'groups', get_string('groupsettingsheader', '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);

            $mform->addElement('selectyesno', 'groupmodeforce', get_string('groupmodeforce', 'group'));
            $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);
        }

        // ROLE RENAMING!
        if ($sectodisp["rolerenaming"] == 1) {
            if ((empty($course->id) && guess_if_creator_will_have_course_capability('moodle/course:renameroles', $categorycontext))
                || (!empty($course->id) && has_capability('moodle/course:renameroles', $coursecontext))) {
                // Customizable role names in this course.
                $mform->addElement('header', 'rolerenaming', get_string('rolerenaming'));
                $mform->addHelpButton('rolerenaming', 'rolerenaming');

                if ($roles = get_all_roles()) {
                    $roles = role_fix_names($roles, null, ROLENAME_ORIGINAL);
                    $assignableroles = get_roles_for_contextlevels(CONTEXT_COURSE);
                    foreach ($roles as $role) {
                        $mform->addElement('text', 'role_' . $role->id, get_string('yourwordforx', '', $role->localname));
                        $mform->setType('role_' . $role->id, PARAM_TEXT);
                    }
                }
            }
        }

        // TAGS!
        if ($sectodisp["tags"] == 1) {
            if (core_tag_tag::is_enabled('core', 'course') &&
                ((empty($course->id) && guess_if_creator_will_have_course_capability('moodle/course:tag', $categorycontext))
                    || (!empty($course->id) && has_capability('moodle/course:tag', $coursecontext)))) {
                $mform->addElement('header', 'tagshdr', get_string('tags', 'tag'));
                $mform->addElement('tags', 'tags', get_string('tags'),
                    array('itemtype' => 'course', 'component' => 'core'));
            }
        }

        // When two elements we need a group.
        $buttonarray = array();
        $classarray = array('class' => 'form-submit');
        if ($returnto !== 0) {
            $buttonarray[] = &$mform->createElement('submit', 'saveandreturn', get_string('savechangesandreturn'), $classarray);
        }
        $buttonarray[] = &$mform->createElement('submit', 'saveanddisplay', get_string('savechangesanddisplay'), $classarray);
        $buttonarray[] = &$mform->createElement('cancel');
        $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
        $mform->closeHeaderBefore('buttonar');

        $mform->addElement('hidden', 'id', null);
        $mform->setType('id', PARAM_INT);

        // Finally set the current form data.
        $this->set_data($course);
    }

    /**
     * Fill in the current page data for this course.
     */
    public function definition_after_data() {

        global $DB;

        $mform = $this->_form;

        // Add available groupings.
        $courseid = $mform->getElementValue('id');
        if ($courseid 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);
                }
            }
            core_collator::asort($options);
            $gr_el =& $mform->getElement('defaultgroupingid');
            $gr_el->load($options);
        }

        // Add course format options.
        $formatvalue = $mform->getElementValue('format');
        if (is_array($formatvalue) && !empty($formatvalue)) {

            $params = array('format' => $formatvalue[0]);
            // Load the course as well if it is available, course formats may need it to work out they preferred course end date.
            if ($courseid) {
                $params['id'] = $courseid;
            }
            $courseformat = course_get_format((object)$params);

            $elements = $courseformat->create_edit_form_elements($mform);
            for ($i = 0; $i < count($elements); $i++) {
                $mform->insertElementBefore($mform->removeElement($elements[$i]->getName(), false),
                    'addcourseformatoptionshere');
            }

            // Remove newsitems element if format does not support news.
            if (!$courseformat->supports_news()) {
                $mform->removeElement('newsitems');
            }
        }
    }

    /**
     * Validation.
     *
     * @param array $data
     * @param array $files
     * @return array the errors that were found
     */
    public function validation($data, $files) {
        global $DB;

        $errors = parent::validation($data, $files);

        // Add field validation check for duplicate shortname.
        if ($course = $DB->get_record('course', array('shortname' => $data['shortname']), '*', IGNORE_MULTIPLE)) {
            if (empty($data['id']) || $course->id != $data['id']) {
                $errors['shortname'] = get_string('shortnametaken', '', $course->fullname);
            }
        }

        // Add field validation check for duplicate idnumber.
        if (!empty($data['idnumber']) && (empty($data['id']) || $this->course->idnumber != $data['idnumber'])) {
            if ($course = $DB->get_record('course', array('idnumber' => $data['idnumber']), '*', IGNORE_MULTIPLE)) {
                if (empty($data['id']) || $course->id != $data['id']) {
                    $errors['idnumber'] = get_string('courseidnumbertaken', 'error', $course->fullname);
                }
            }
        }

        if ($errorcode = course_validate_dates($data)) {
            $errors['enddate'] = get_string($errorcode, 'error');
        }

        $errors = array_merge($errors, enrol_course_edit_validation($data, $this->context));

        $courseformat = course_get_format((object)array('format' => $data['format']));
        $formaterrors = $courseformat->edit_form_validation($data, $files, $errors);
        if (!empty($formaterrors) && is_array($formaterrors)) {
            $errors = array_merge($errors, $formaterrors);
        }

        return $errors;
    }
}