on-demand release 4.0dev+
[moodle.git] / admin / tool / uploadcourse / classes / step2_form.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Bulk course upload step 2.
19  *
20  * @package    tool_uploadcourse
21  * @copyright  2011 Piers Harding
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->dirroot . '/course/lib.php');
29 /**
30  * Specify course upload details.
31  *
32  * @package    tool_uploadcourse
33  * @copyright  2011 Piers Harding
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class tool_uploadcourse_step2_form extends tool_uploadcourse_base_form {
38     /**
39      * The standard form definiton.
40      * @return void.
41      */
42     public function definition () {
43         global $CFG;
45         $mform   = $this->_form;
46         $data    = $this->_customdata['data'];
47         $courseconfig = get_config('moodlecourse');
49         // Import options.
50         $this->add_import_options();
52         // Course options.
53         $mform->addElement('header', 'courseoptionshdr', get_string('courseprocess', 'tool_uploadcourse'));
54         $mform->setExpanded('courseoptionshdr', true);
56         $mform->addElement('text', 'options[shortnametemplate]', get_string('shortnametemplate', 'tool_uploadcourse'),
57             'maxlength="100" size="20"');
58         $mform->setType('options[shortnametemplate]', PARAM_RAW);
59         $mform->addHelpButton('options[shortnametemplate]', 'shortnametemplate', 'tool_uploadcourse');
60         $mform->hideIf('options[shortnametemplate]', 'options[mode]', 'eq', tool_uploadcourse_processor::MODE_CREATE_OR_UPDATE);
61         $mform->hideIf('options[shortnametemplate]', 'options[mode]', 'eq', tool_uploadcourse_processor::MODE_UPDATE_ONLY);
63         // Restore file is not in the array options on purpose, because formslib can't handle it!
64         $contextid = $this->_customdata['contextid'];
65         $mform->addElement('hidden', 'contextid', $contextid);
66         $mform->setType('contextid', PARAM_INT);
67         $mform->addElement('filepicker', 'restorefile', get_string('templatefile', 'tool_uploadcourse'));
68         $mform->addHelpButton('restorefile', 'templatefile', 'tool_uploadcourse');
70         $mform->addElement('text', 'options[templatecourse]', get_string('coursetemplatename', 'tool_uploadcourse'));
71         $mform->setType('options[templatecourse]', PARAM_TEXT);
72         $mform->addHelpButton('options[templatecourse]', 'coursetemplatename', 'tool_uploadcourse');
74         $mform->addElement('selectyesno', 'options[reset]', get_string('reset', 'tool_uploadcourse'));
75         $mform->setDefault('options[reset]', 0);
76         $mform->hideIf('options[reset]', 'options[mode]', 'eq', tool_uploadcourse_processor::MODE_CREATE_NEW);
77         $mform->hideIf('options[reset]', 'options[mode]', 'eq', tool_uploadcourse_processor::MODE_CREATE_ALL);
78         $mform->disabledIf('options[reset]', 'options[allowresets]', 'eq', 0);
79         $mform->addHelpButton('options[reset]', 'reset', 'tool_uploadcourse');
81         // Default values.
82         $mform->addElement('header', 'defaultheader', get_string('defaultvalues', 'tool_uploadcourse'));
83         $mform->setExpanded('defaultheader', true);
85         $displaylist = core_course_category::make_categories_list('moodle/course:create');
86         $mform->addElement('autocomplete', 'defaults[category]', get_string('coursecategory'), $displaylist);
87         $mform->addHelpButton('defaults[category]', 'coursecategory');
89         $choices = array();
90         $choices['0'] = get_string('hide');
91         $choices['1'] = get_string('show');
92         $mform->addElement('select', 'defaults[visible]', get_string('coursevisibility'), $choices);
93         $mform->addHelpButton('defaults[visible]', 'coursevisibility');
94         $mform->setDefault('defaults[visible]', $courseconfig->visible);
96         if ($CFG->downloadcoursecontentallowed &&
97                 has_capability('moodle/course:configuredownloadcontent', context::instance_by_id($contextid))) {
99             $downloadchoices = [
100                 DOWNLOAD_COURSE_CONTENT_DISABLED => get_string('no'),
101                 DOWNLOAD_COURSE_CONTENT_ENABLED => get_string('yes'),
102             ];
104             $sitedefaultstring = $downloadchoices[$courseconfig->downloadcontentsitedefault];
105             $downloadchoices[DOWNLOAD_COURSE_CONTENT_SITE_DEFAULT] = get_string('sitedefaultspecified', '', $sitedefaultstring);
106             $downloadselectdefault = $courseconfig->downloadcontent ?? DOWNLOAD_COURSE_CONTENT_SITE_DEFAULT;
108             $mform->addElement('select', 'defaults[downloadcontent]', get_string('enabledownloadcoursecontent', 'course'),
109                 $downloadchoices);
110             $mform->addHelpButton('defaults[downloadcontent]', 'downloadcoursecontent', 'course');
111             $mform->setDefault('defaults[downloadcontent]', $downloadselectdefault);
112         }
114         $mform->addElement('date_time_selector', 'defaults[startdate]', get_string('startdate'));
115         $mform->addHelpButton('defaults[startdate]', 'startdate');
116         $mform->setDefault('defaults[startdate]', time() + 3600 * 24);
118         $mform->addElement('date_time_selector', 'defaults[enddate]', get_string('enddate'), array('optional' => true));
119         $mform->addHelpButton('defaults[enddate]', 'enddate');
121         $courseformats = get_sorted_course_formats(true);
122         $formcourseformats = array();
123         foreach ($courseformats as $courseformat) {
124             $formcourseformats[$courseformat] = get_string('pluginname', "format_$courseformat");
125         }
126         $mform->addElement('select', 'defaults[format]', get_string('format'), $formcourseformats);
127         $mform->addHelpButton('defaults[format]', 'format');
128         $mform->setDefault('defaults[format]', $courseconfig->format);
130         if (!empty($CFG->allowcoursethemes)) {
131             $themeobjects = get_list_of_themes();
132             $themes=array();
133             $themes[''] = get_string('forceno');
134             foreach ($themeobjects as $key => $theme) {
135                 if (empty($theme->hidefromselector)) {
136                     $themes[$key] = get_string('pluginname', 'theme_'.$theme->name);
137                 }
138             }
139             $mform->addElement('select', 'defaults[theme]', get_string('forcetheme'), $themes);
140         }
142         $languages = array();
143         $languages[''] = get_string('forceno');
144         $languages += get_string_manager()->get_list_of_translations();
145         $mform->addElement('select', 'defaults[lang]', get_string('forcelanguage'), $languages);
146         $mform->setDefault('defaults[lang]', $courseconfig->lang);
148         $options = range(0, 10);
149         $mform->addElement('select', 'defaults[newsitems]', get_string('newsitemsnumber'), $options);
150         $mform->addHelpButton('defaults[newsitems]', 'newsitemsnumber');
151         $mform->setDefault('defaults[newsitems]', $courseconfig->newsitems);
153         $mform->addElement('selectyesno', 'defaults[showgrades]', get_string('showgrades'));
154         $mform->addHelpButton('defaults[showgrades]', 'showgrades');
155         $mform->setDefault('defaults[showgrades]', $courseconfig->showgrades);
157         $mform->addElement('selectyesno', 'defaults[showreports]', get_string('showreports'));
158         $mform->addHelpButton('defaults[showreports]', 'showreports');
159         $mform->setDefault('defaults[showreports]', $courseconfig->showreports);
161         if (!empty($CFG->legacyfilesinnewcourses)) {
162             $mform->addElement('select', 'defaults[legacyfiles]', get_string('courselegacyfiles'), $choices);
163             $mform->addHelpButton('defaults[legacyfiles]', 'courselegacyfiles');
164             if (!isset($courseconfig->legacyfiles)) {
165                 $courseconfig->legacyfiles = 0;
166             }
167             $mform->setDefault('defaults[legacyfiles]', $courseconfig->legacyfiles);
168         }
170         $choices = get_max_upload_sizes($CFG->maxbytes);
171         $mform->addElement('select', 'defaults[maxbytes]', get_string('maximumupload'), $choices);
172         $mform->addHelpButton('defaults[maxbytes]', 'maximumupload');
173         $mform->setDefault('defaults[maxbytes]', $courseconfig->maxbytes);
175         $choices = array();
176         $choices[NOGROUPS] = get_string('groupsnone', 'group');
177         $choices[SEPARATEGROUPS] = get_string('groupsseparate', 'group');
178         $choices[VISIBLEGROUPS] = get_string('groupsvisible', 'group');
179         $mform->addElement('select', 'defaults[groupmode]', get_string('groupmode', 'group'), $choices);
180         $mform->addHelpButton('defaults[groupmode]', 'groupmode', 'group');
181         $mform->setDefault('defaults[groupmode]', $courseconfig->groupmode);
183         $mform->addElement('selectyesno', 'defaults[groupmodeforce]', get_string('groupmodeforce', 'group'));
184         $mform->addHelpButton('defaults[groupmodeforce]', 'groupmodeforce', 'group');
185         $mform->setDefault('defaults[groupmodeforce]', $courseconfig->groupmodeforce);
187         // Completion tracking.
188         if (!empty($CFG->enablecompletion)) {
189             $mform->addElement('selectyesno', 'defaults[enablecompletion]', get_string('enablecompletion', 'completion'));
190             $mform->setDefault('defaults[enablecompletion]', $courseconfig->enablecompletion);
191             $mform->addHelpButton('defaults[enablecompletion]', 'enablecompletion', 'completion');
192         }
194         // Add custom fields to the form.
195         $handler = \core_course\customfield\course_handler::create();
196         $handler->instance_form_definition($mform, 0, 'defaultvaluescustomfieldcategory', 'tool_uploadcourse');
198         // Hidden fields.
199         $mform->addElement('hidden', 'importid');
200         $mform->setType('importid', PARAM_INT);
202         $mform->addElement('hidden', 'previewrows');
203         $mform->setType('previewrows', PARAM_INT);
205         $this->add_action_buttons(true, get_string('uploadcourses', 'tool_uploadcourse'));
207         // Prepare custom fields data.
208         $data = (object) $data;
209         $handler->instance_form_before_set_data($data);
211         $this->set_data($data);
212     }
214     /**
215      * Add actopm buttons.
216      *
217      * @param bool $cancel whether to show cancel button, default true
218      * @param string $submitlabel label for submit button, defaults to get_string('savechanges')
219      * @return void
220      */
221     public function add_action_buttons($cancel = true, $submitlabel = null) {
222         $mform =& $this->_form;
223         $buttonarray = array();
224         $buttonarray[] = &$mform->createElement('submit', 'showpreview', get_string('preview', 'tool_uploadcourse'));
225         $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submitlabel);
226         $buttonarray[] = &$mform->createElement('cancel');
227         $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
228         $mform->closeHeaderBefore('buttonar');
229     }
231     /**
232      * Sets the enddate default after set_data is called.
233      */
234     public function definition_after_data() {
236         $mform = $this->_form;
238         // The default end date depends on the course format.
239         $format = course_get_format((object)array('format' => get_config('moodlecourse', 'format')));
241         // Check if course end date form field should be enabled by default.
242         // If a default date is provided to the form element, it is magically enabled by default in the
243         // MoodleQuickForm_date_time_selector class, otherwise it's disabled by default.
244         if (get_config('moodlecourse', 'courseenddateenabled')) {
245             $enddate = $format->get_default_course_enddate($mform, array('startdate' => 'defaults[startdate]'));
246             $mform->setDefault('defaults[enddate]', $enddate);
247         }
249         // Tweak the form with values provided by custom fields in use.
250         \core_course\customfield\course_handler::create()->instance_form_definition_after_data($mform);
251     }
253     /**
254      * Validation.
255      *
256      * @param array $data
257      * @param array $files
258      * @return array the errors that were found
259      */
260     public function validation($data, $files) {
261         global $DB;
263         $errors = parent::validation($data, $files);
265         if ($errorcode = course_validate_dates($data['defaults'])) {
266             $errors['defaults[enddate]'] = get_string($errorcode, 'error');
267         }
269         // Custom fields validation.
270         array_merge($errors, \core_course\customfield\course_handler::create()->instance_form_validation($data, $files));
272         return $errors;
273     }