0b7c175056ca76ace70dccaa2de9d9053bc85cf3
[moodle.git] / calendar / classes / local / event / forms / create.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  * The mform for creating a calendar event. Based on the old event form.
19  *
20  * @package    core_calendar
21  * @copyright 2017 Ryan Wyllie <ryan@moodle.com>
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace core_calendar\local\event\forms;
26 defined('MOODLE_INTERNAL') || die();
28 require_once($CFG->dirroot.'/lib/formslib.php');
30 /**
31  * The mform class for creating a calendar event.
32  *
33  * @copyright 2017 Ryan Wyllie <ryan@moodle.com>
34  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class create extends \moodleform {
38     /**
39      * Build the editor options using the given context.
40      *
41      * @param \context $context A Moodle context
42      * @return array
43      */
44     public static function build_editor_options(\context $context) {
45         global $CFG;
47         return [
48             'context' => $context,
49             'maxfiles' => EDITOR_UNLIMITED_FILES,
50             'maxbytes' => $CFG->maxbytes,
51             'noclean' => true
52         ];
53     }
55     /**
56      * The form definition
57      */
58     public function definition() {
59         global $PAGE;
61         $mform = $this->_form;
62         $starttime = isset($this->_customdata['starttime']) ? $this->_customdata['starttime'] : 0;
63         $editoroptions = !(empty($this->_customdata['editoroptions'])) ? $this->_customdata['editoroptions'] : null;
64         $eventtypes = calendar_get_all_allowed_types();
66         if (empty($eventtypes)) {
67             print_error('nopermissiontoupdatecalendar');
68         }
70         $mform->setDisableShortforms();
71         $mform->disable_form_change_checker();
73         // Empty string so that the element doesn't get rendered.
74         $mform->addElement('header', 'general', '');
76         $this->add_default_hidden_elements($mform);
78         // Event name field.
79         $mform->addElement('text', 'name', get_string('eventname', 'calendar'), 'size="50"');
80         $mform->addRule('name', get_string('required'), 'required', null, 'client');
81         $mform->setType('name', PARAM_TEXT);
83         // Event time start field.
84         $mform->addElement('date_time_selector', 'timestart', get_string('date'), ['defaulttime' => $starttime]);
86         // Add the select elements for the available event types.
87         $this->add_event_type_elements($mform, $eventtypes);
89         // Start of advanced elements.
90         // Advanced elements are not visible to the user by default.
91         // They are displayed through the user of a show more / less button.
92         $mform->addElement('editor', 'description', get_string('eventdescription', 'calendar'), ['rows' => 3], $editoroptions);
93         $mform->setType('description', PARAM_RAW);
94         $mform->setAdvanced('description');
96         // Add the variety of elements allowed for selecting event duration.
97         $this->add_event_duration_elements($mform);
99         // Add the form elements for repeating events.
100         $this->add_event_repeat_elements($mform);
102         // Add the javascript required to enhance this mform.
103         $PAGE->requires->js_call_amd('core_calendar/event_form', 'init', [$mform->getAttribute('id')]);
104     }
106     /**
107      * A bit of custom validation for this form
108      *
109      * @param array $data An assoc array of field=>value
110      * @param array $files An array of files
111      * @return array
112      */
113     public function validation($data, $files) {
114         global $DB, $CFG;
116         $errors = parent::validation($data, $files);
117         $coursekey = isset($data['groupcourseid']) ? 'groupcourseid' : 'courseid';
118         $eventtypes = calendar_get_all_allowed_types();
119         $eventtype = isset($data['eventtype']) ? $data['eventtype'] : null;
121         if (empty($eventtype) || !isset($eventtypes[$eventtype])) {
122             $errors['eventtype'] = get_string('invalideventtype', 'calendar');
123         }
125         if (isset($data[$coursekey]) && $data[$coursekey] > 0) {
126             if ($course = $DB->get_record('course', ['id' => $data[$coursekey]])) {
127                 if ($data['timestart'] < $course->startdate) {
128                     $errors['timestart'] = get_string('errorbeforecoursestart', 'calendar');
129                 }
130             } else {
131                 $errors[$coursekey] = get_string('invalidcourse', 'error');
132             }
133         }
135         if ($eventtype == 'course' && empty($data['courseid'])) {
136             $errors['courseid'] = get_string('selectacourse');
137         }
139         if ($data['duration'] == 1 && $data['timestart'] > $data['timedurationuntil']) {
140             $errors['durationgroup'] = get_string('invalidtimedurationuntil', 'calendar');
141         } else if ($data['duration'] == 2 && (trim($data['timedurationminutes']) == '' || $data['timedurationminutes'] < 1)) {
142             $errors['durationgroup'] = get_string('invalidtimedurationminutes', 'calendar');
143         }
145         return $errors;
146     }
148     /**
149      * Add the list of hidden elements that should appear in this form each
150      * time. These elements will never be visible to the user.
151      *
152      * @param MoodleQuickForm $mform
153      */
154     protected function add_default_hidden_elements($mform) {
155         global $USER;
157         // Add some hidden fields.
158         $mform->addElement('hidden', 'id');
159         $mform->setType('id', PARAM_INT);
160         $mform->setDefault('id', 0);
162         $mform->addElement('hidden', 'userid');
163         $mform->setType('userid', PARAM_INT);
164         $mform->setDefault('userid', $USER->id);
166         $mform->addElement('hidden', 'modulename');
167         $mform->setType('modulename', PARAM_INT);
168         $mform->setDefault('modulename', '');
170         $mform->addElement('hidden', 'instance');
171         $mform->setType('instance', PARAM_INT);
172         $mform->setDefault('instance', 0);
174         $mform->addElement('hidden', 'visible');
175         $mform->setType('visible', PARAM_INT);
176         $mform->setDefault('visible', 1);
177     }
179     /**
180      * Add the appropriate elements for the available event types.
181      *
182      * If the only event type available is 'user' then we add a hidden
183      * element because there is nothing for the user to choose.
184      *
185      * If more than one type is available then we add the elements as
186      * follows:
187      *      - Always add the event type selector
188      *      - Elements per type:
189      *          - course: add an additional select element with each
190      *                    course as an option.
191      *          - group: add a select element for the course (different
192      *                   from the above course select) and a select
193      *                   element for the group.
194      *
195      * @param MoodleQuickForm $mform
196      * @param array $eventtypes The available event types for the user
197      */
198     protected function add_event_type_elements($mform, $eventtypes) {
199         $options = [];
201         if (isset($eventtypes['user'])) {
202             $options['user'] = get_string('user');
203         }
204         if (isset($eventtypes['group'])) {
205             $options['group'] = get_string('group');
206         }
207         if (isset($eventtypes['course'])) {
208             $options['course'] = get_string('course');
209         }
210         if (isset($eventtypes['category'])) {
211             $options['category'] = get_string('category');
212         }
213         if (isset($eventtypes['site'])) {
214             $options['site'] = get_string('site');
215         }
217         // If we only have one event type and it's 'user' event then don't bother
218         // rendering the select boxes because there is no choice for the user to
219         // make.
220         if (count(array_keys($eventtypes)) == 1 && isset($eventtypes['user'])) {
221             $mform->addElement('hidden', 'eventtype');
222             $mform->setType('eventtype', PARAM_TEXT);
223             $mform->setDefault('eventtype', 'user');
225             // Render a static element to tell the user what type of event will
226             // be created.
227             $mform->addElement('static', 'staticeventtype', get_string('eventkind', 'calendar'), $options['user']);
228             return;
229         } else {
230             $mform->addElement('select', 'eventtype', get_string('eventkind', 'calendar'), $options);
231         }
233         if (isset($eventtypes['category'])) {
234             $categoryoptions = [];
235             foreach ($eventtypes['category'] as $id => $category) {
236                 $categoryoptions[$id] = $category;
237             }
239             $mform->addElement('select', 'categoryid', get_string('category'), $categoryoptions);
240             $mform->hideIf('categoryid', 'eventtype', 'noteq', 'category');
241         }
243         if (isset($eventtypes['course'])) {
244             $mform->addElement('course', 'courseid', get_string('course'), ['limittoenrolled' => true]);
245             $mform->hideIf('courseid', 'eventtype', 'noteq', 'course');
246         }
248         if (isset($eventtypes['group'])) {
249             $courseoptions = [];
250             foreach ($eventtypes['groupcourses'] as $course) {
251                 $courseoptions[$course->id] = format_string($course->fullname, true,
252                     ['context' => \context_course::instance($course->id)]);
253             }
255             $mform->addElement('select', 'groupcourseid', get_string('course'), $courseoptions);
256             $mform->hideIf('groupcourseid', 'eventtype', 'noteq', 'group');
258             $groupoptions = [];
259             foreach ($eventtypes['group'] as $group) {
260                 // We are formatting it this way in order to provide the javascript both
261                 // the course and group ids so that it can enhance the form for the user.
262                 $index = "{$group->courseid}-{$group->id}";
263                 $groupoptions[$index] = format_string($group->name, true,
264                     ['context' => \context_course::instance($group->courseid)]);
265             }
267             $mform->addElement('select', 'groupid', get_string('group'), $groupoptions);
268             $mform->hideIf('groupid', 'eventtype', 'noteq', 'group');
269         }
270     }
272     /**
273      * Add the various elements to express the duration options available
274      * for an event.
275      *
276      * @param MoodleQuickForm $mform
277      */
278     protected function add_event_duration_elements($mform) {
279         $group = [];
280         $group[] = $mform->createElement('radio', 'duration', null, get_string('durationnone', 'calendar'), 0);
281         $group[] = $mform->createElement('radio', 'duration', null, get_string('durationuntil', 'calendar'), 1);
282         $group[] = $mform->createElement('date_time_selector', 'timedurationuntil', '');
283         $group[] = $mform->createElement('radio', 'duration', null, get_string('durationminutes', 'calendar'), 2);
284         $group[] = $mform->createElement('text', 'timedurationminutes', get_string('durationminutes', 'calendar'));
286         $mform->addGroup($group, 'durationgroup', get_string('eventduration', 'calendar'), '<br />', false);
287         $mform->setAdvanced('durationgroup');
289         $mform->disabledIf('timedurationuntil',         'duration', 'noteq', 1);
290         $mform->disabledIf('timedurationuntil[day]',    'duration', 'noteq', 1);
291         $mform->disabledIf('timedurationuntil[month]',  'duration', 'noteq', 1);
292         $mform->disabledIf('timedurationuntil[year]',   'duration', 'noteq', 1);
293         $mform->disabledIf('timedurationuntil[hour]',   'duration', 'noteq', 1);
294         $mform->disabledIf('timedurationuntil[minute]', 'duration', 'noteq', 1);
296         $mform->setType('timedurationminutes', PARAM_INT);
297         $mform->disabledIf('timedurationminutes', 'duration', 'noteq', 2);
299         $mform->setDefault('duration', 0);
300     }
302     /**
303      * Add the repeat elements for the form when creating a new event.
304      *
305      * @param MoodleQuickForm $mform
306      */
307     protected function add_event_repeat_elements($mform) {
308         $mform->addElement('checkbox', 'repeat', get_string('repeatevent', 'calendar'), null);
309         $mform->addElement('text', 'repeats', get_string('repeatweeksl', 'calendar'), 'maxlength="10" size="10"');
310         $mform->setType('repeats', PARAM_INT);
311         $mform->setDefault('repeats', 1);
312         $mform->disabledIf('repeats', 'repeat', 'notchecked');
313         $mform->setAdvanced('repeat');
314         $mform->setAdvanced('repeats');
315     }