129bf60183f843d238e2255fa9061a248d387942
[moodle.git] / calendar / externallib.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/>.
18 /**
19  * External calendar API
20  *
21  * @package    core_calendar
22  * @category   external
23  * @copyright  2012 Ankit Agarwal
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  * @since Moodle 2.5
26  */
28 defined('MOODLE_INTERNAL') || die;
30 require_once("$CFG->libdir/externallib.php");
32 use \core_calendar\local\api as local_api;
33 use \core_calendar\local\event\container as event_container;
34 use \core_calendar\local\event\forms\create as create_event_form;
35 use \core_calendar\local\event\forms\update as update_event_form;
36 use \core_calendar\local\event\mappers\create_update_form_mapper;
37 use \core_calendar\external\event_exporter;
38 use \core_calendar\external\events_exporter;
39 use \core_calendar\external\events_grouped_by_course_exporter;
40 use \core_calendar\external\events_related_objects_cache;
42 /**
43  * Calendar external functions
44  *
45  * @package    core_calendar
46  * @category   external
47  * @copyright  2012 Ankit Agarwal
48  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
49  * @since Moodle 2.5
50  */
51 class core_calendar_external extends external_api {
54     /**
55      * Returns description of method parameters
56      *
57      * @return external_function_parameters
58      * @since Moodle 2.5
59      */
60     public static function delete_calendar_events_parameters() {
61         return new external_function_parameters(
62                 array('events' => new external_multiple_structure(
63                         new external_single_structure(
64                                 array(
65                                         'eventid' => new external_value(PARAM_INT, 'Event ID', VALUE_REQUIRED, '', NULL_NOT_ALLOWED),
66                                         'repeat'  => new external_value(PARAM_BOOL, 'Delete comeplete series if repeated event')
67                                 ), 'List of events to delete'
68                         )
69                     )
70                 )
71         );
72     }
74     /**
75      * Delete Calendar events
76      *
77      * @param array $eventids A list of event ids with repeat flag to delete
78      * @return null
79      * @since Moodle 2.5
80      */
81     public static function delete_calendar_events($events) {
82         global $CFG, $DB;
83         require_once($CFG->dirroot."/calendar/lib.php");
85         // Parameter validation.
86         $params = self::validate_parameters(self:: delete_calendar_events_parameters(), array('events' => $events));
88         $transaction = $DB->start_delegated_transaction();
90         foreach ($params['events'] as $event) {
91             $eventobj = calendar_event::load($event['eventid']);
93             // Let's check if the user is allowed to delete an event.
94             if (!calendar_edit_event_allowed($eventobj)) {
95                 throw new moodle_exception("nopermissions");
96             }
97             // Time to do the magic.
98             $eventobj->delete($event['repeat']);
99         }
101         // Everything done smoothly, let's commit.
102         $transaction->allow_commit();
104         return null;
105     }
107     /**
108      * Returns description of method result value
109      *
110      * @return external_description
111      * @since Moodle 2.5
112      */
113     public static function  delete_calendar_events_returns() {
114         return null;
115     }
117     /**
118      * Returns description of method parameters
119      *
120      * @return external_function_parameters
121      * @since Moodle 2.5
122      */
123     public static function get_calendar_events_parameters() {
124         return new external_function_parameters(
125                 array('events' => new external_single_structure(
126                             array(
127                                     'eventids' => new external_multiple_structure(
128                                             new external_value(PARAM_INT, 'event ids')
129                                             , 'List of event ids',
130                                             VALUE_DEFAULT, array(), NULL_ALLOWED
131                                                 ),
132                                     'courseids' => new external_multiple_structure(
133                                             new external_value(PARAM_INT, 'course ids')
134                                             , 'List of course ids for which events will be returned',
135                                             VALUE_DEFAULT, array(), NULL_ALLOWED
136                                                 ),
137                                     'groupids' => new external_multiple_structure(
138                                             new external_value(PARAM_INT, 'group ids')
139                                             , 'List of group ids for which events should be returned',
140                                             VALUE_DEFAULT, array(), NULL_ALLOWED
141                                                 )
142                             ), 'Event details', VALUE_DEFAULT, array()),
143                     'options' => new external_single_structure(
144                             array(
145                                     'userevents' => new external_value(PARAM_BOOL,
146                                              "Set to true to return current user's user events",
147                                              VALUE_DEFAULT, true, NULL_ALLOWED),
148                                     'siteevents' => new external_value(PARAM_BOOL,
149                                              "Set to true to return global events",
150                                              VALUE_DEFAULT, true, NULL_ALLOWED),
151                                     'timestart' => new external_value(PARAM_INT,
152                                              "Time from which events should be returned",
153                                              VALUE_DEFAULT, 0, NULL_ALLOWED),
154                                     'timeend' => new external_value(PARAM_INT,
155                                              "Time to which the events should be returned. We treat 0 and null as no end",
156                                              VALUE_DEFAULT, 0, NULL_ALLOWED),
157                                     'ignorehidden' => new external_value(PARAM_BOOL,
158                                              "Ignore hidden events or not",
159                                              VALUE_DEFAULT, true, NULL_ALLOWED),
161                             ), 'Options', VALUE_DEFAULT, array())
162                 )
163         );
164     }
166     /**
167      * Get Calendar events
168      *
169      * @param array $events A list of events
170      * @param array $options various options
171      * @return array Array of event details
172      * @since Moodle 2.5
173      */
174     public static function get_calendar_events($events = array(), $options = array()) {
175         global $SITE, $DB, $USER, $CFG;
176         require_once($CFG->dirroot."/calendar/lib.php");
178         // Parameter validation.
179         $params = self::validate_parameters(self::get_calendar_events_parameters(), array('events' => $events, 'options' => $options));
180         $funcparam = array('courses' => array(), 'groups' => array());
181         $hassystemcap = has_capability('moodle/calendar:manageentries', context_system::instance());
182         $warnings = array();
184         // Let us findout courses that we can return events from.
185         if (!$hassystemcap) {
186             $courses = enrol_get_my_courses('id');
187             $courses = array_keys($courses);
188             foreach ($params['events']['courseids'] as $id) {
189                try {
190                     $context = context_course::instance($id);
191                     self::validate_context($context);
192                     $funcparam['courses'][] = $id;
193                 } catch (Exception $e) {
194                     $warnings[] = array(
195                         'item' => 'course',
196                         'itemid' => $id,
197                         'warningcode' => 'nopermissions',
198                         'message' => 'No access rights in course context '.$e->getMessage().$e->getTraceAsString()
199                     );
200                 }
201             }
202         } else {
203             $courses = $params['events']['courseids'];
204             $funcparam['courses'] = $courses;
205         }
207         // Let us findout groups that we can return events from.
208         if (!$hassystemcap) {
209             $groups = groups_get_my_groups();
210             $groups = array_keys($groups);
211             foreach ($params['events']['groupids'] as $id) {
212                 if (in_array($id, $groups)) {
213                     $funcparam['groups'][] = $id;
214                 } else {
215                     $warnings[] = array('item' => $id, 'warningcode' => 'nopermissions', 'message' => 'you do not have permissions to access this group');
216                 }
217             }
218         } else {
219             $groups = $params['events']['groupids'];
220             $funcparam['groups'] = $groups;
221         }
223         // Do we need user events?
224         if (!empty($params['options']['userevents'])) {
225             $funcparam['users'] = array($USER->id);
226         } else {
227             $funcparam['users'] = false;
228         }
230         // Do we need site events?
231         if (!empty($params['options']['siteevents'])) {
232             $funcparam['courses'][] = $SITE->id;
233         }
235         // We treat 0 and null as no end.
236         if (empty($params['options']['timeend'])) {
237             $params['options']['timeend'] = PHP_INT_MAX;
238         }
240         // Event list does not check visibility and permissions, we'll check that later.
241         $eventlist = calendar_get_legacy_events($params['options']['timestart'], $params['options']['timeend'],
242             $funcparam['users'], $funcparam['groups'], $funcparam['courses'], true, $params['options']['ignorehidden']);
244         // WS expects arrays.
245         $events = array();
247         // We need to get events asked for eventids.
248         if ($eventsbyid = calendar_get_events_by_id($params['events']['eventids'])) {
249             $eventlist += $eventsbyid;
250         }
252         foreach ($eventlist as $eventid => $eventobj) {
253             $event = (array) $eventobj;
254             // Description formatting.
255             $calendareventobj = new calendar_event($event);
256             list($event['description'], $event['format']) = $calendareventobj->format_external_text();
258             if ($hassystemcap) {
259                 // User can see everything, no further check is needed.
260                 $events[$eventid] = $event;
261             } else if (!empty($eventobj->modulename)) {
262                 $courseid = $eventobj->courseid;
263                 if (!$courseid) {
264                     if (!$calendareventobj->context || !($context = $calendareventobj->context->get_course_context(false))) {
265                         continue;
266                     }
267                     $courseid = $context->instanceid;
268                 }
269                 $instances = get_fast_modinfo($courseid)->get_instances_of($eventobj->modulename);
270                 if (!empty($instances[$eventobj->instance]->uservisible)) {
271                     $events[$eventid] = $event;
272                 }
273             } else {
274                 // Can the user actually see this event?
275                 $eventobj = calendar_event::load($eventobj);
276                 if (($eventobj->courseid == $SITE->id) ||
277                             (!empty($eventobj->groupid) && in_array($eventobj->groupid, $groups)) ||
278                             (!empty($eventobj->courseid) && in_array($eventobj->courseid, $courses)) ||
279                             ($USER->id == $eventobj->userid) ||
280                             (calendar_edit_event_allowed($eventid))) {
281                     $events[$eventid] = $event;
282                 } else {
283                     $warnings[] = array('item' => $eventid, 'warningcode' => 'nopermissions', 'message' => 'you do not have permissions to view this event');
284                 }
285             }
286         }
287         return array('events' => $events, 'warnings' => $warnings);
288     }
290     /**
291      * Returns description of method result value
292      *
293      * @return external_description
294      * @since Moodle 2.5
295      */
296     public static function  get_calendar_events_returns() {
297         return new external_single_structure(array(
298                 'events' => new external_multiple_structure( new external_single_structure(
299                         array(
300                             'id' => new external_value(PARAM_INT, 'event id'),
301                             'name' => new external_value(PARAM_TEXT, 'event name'),
302                             'description' => new external_value(PARAM_RAW, 'Description', VALUE_OPTIONAL, null, NULL_ALLOWED),
303                             'format' => new external_format_value('description'),
304                             'courseid' => new external_value(PARAM_INT, 'course id'),
305                             'groupid' => new external_value(PARAM_INT, 'group id'),
306                             'userid' => new external_value(PARAM_INT, 'user id'),
307                             'repeatid' => new external_value(PARAM_INT, 'repeat id'),
308                             'modulename' => new external_value(PARAM_TEXT, 'module name', VALUE_OPTIONAL, null, NULL_ALLOWED),
309                             'instance' => new external_value(PARAM_INT, 'instance id'),
310                             'eventtype' => new external_value(PARAM_TEXT, 'Event type'),
311                             'timestart' => new external_value(PARAM_INT, 'timestart'),
312                             'timeduration' => new external_value(PARAM_INT, 'time duration'),
313                             'visible' => new external_value(PARAM_INT, 'visible'),
314                             'uuid' => new external_value(PARAM_TEXT, 'unique id of ical events', VALUE_OPTIONAL, null, NULL_NOT_ALLOWED),
315                             'sequence' => new external_value(PARAM_INT, 'sequence'),
316                             'timemodified' => new external_value(PARAM_INT, 'time modified'),
317                             'subscriptionid' => new external_value(PARAM_INT, 'Subscription id', VALUE_OPTIONAL, null, NULL_ALLOWED),
318                         ), 'event')
319                  ),
320                  'warnings' => new external_warnings()
321                 )
322         );
323     }
325     /**
326      * Returns description of method parameters.
327      *
328      * @since Moodle 3.3
329      * @return external_function_parameters
330      */
331     public static function get_calendar_action_events_by_timesort_parameters() {
332         return new external_function_parameters(
333             array(
334                 'timesortfrom' => new external_value(PARAM_INT, 'Time sort from', VALUE_DEFAULT, 0),
335                 'timesortto' => new external_value(PARAM_INT, 'Time sort to', VALUE_DEFAULT, null),
336                 'aftereventid' => new external_value(PARAM_INT, 'The last seen event id', VALUE_DEFAULT, 0),
337                 'limitnum' => new external_value(PARAM_INT, 'Limit number', VALUE_DEFAULT, 20)
338             )
339         );
340     }
342     /**
343      * Get calendar action events based on the timesort value.
344      *
345      * @since Moodle 3.3
346      * @param null|int $timesortfrom Events after this time (inclusive)
347      * @param null|int $timesortto Events before this time (inclusive)
348      * @param null|int $aftereventid Get events with ids greater than this one
349      * @param int $limitnum Limit the number of results to this value
350      * @return array
351      */
352     public static function get_calendar_action_events_by_timesort($timesortfrom = 0, $timesortto = null,
353                                                        $aftereventid = 0, $limitnum = 20) {
354         global $CFG, $PAGE, $USER;
356         require_once($CFG->dirroot . '/calendar/lib.php');
358         $user = null;
359         $params = self::validate_parameters(
360             self::get_calendar_action_events_by_timesort_parameters(),
361             [
362                 'timesortfrom' => $timesortfrom,
363                 'timesortto' => $timesortto,
364                 'aftereventid' => $aftereventid,
365                 'limitnum' => $limitnum,
366             ]
367         );
368         $context = \context_user::instance($USER->id);
369         self::validate_context($context);
371         if (empty($params['aftereventid'])) {
372             $params['aftereventid'] = null;
373         }
375         $renderer = $PAGE->get_renderer('core_calendar');
376         $events = local_api::get_action_events_by_timesort(
377             $params['timesortfrom'],
378             $params['timesortto'],
379             $params['aftereventid'],
380             $params['limitnum']
381         );
383         $exportercache = new events_related_objects_cache($events);
384         $exporter = new events_exporter($events, ['cache' => $exportercache]);
386         return $exporter->export($renderer);
387     }
389     /**
390      * Returns description of method result value.
391      *
392      * @since Moodle 3.3
393      * @return external_description
394      */
395     public static function get_calendar_action_events_by_timesort_returns() {
396         return events_exporter::get_read_structure();
397     }
399     /**
400      * Returns description of method parameters.
401      *
402      * @return external_function_parameters
403      */
404     public static function get_calendar_action_events_by_course_parameters() {
405         return new external_function_parameters(
406             array(
407                 'courseid' => new external_value(PARAM_INT, 'Course id'),
408                 'timesortfrom' => new external_value(PARAM_INT, 'Time sort from', VALUE_DEFAULT, null),
409                 'timesortto' => new external_value(PARAM_INT, 'Time sort to', VALUE_DEFAULT, null),
410                 'aftereventid' => new external_value(PARAM_INT, 'The last seen event id', VALUE_DEFAULT, 0),
411                 'limitnum' => new external_value(PARAM_INT, 'Limit number', VALUE_DEFAULT, 20)
412             )
413         );
414     }
416     /**
417      * Get calendar action events for the given course.
418      *
419      * @since Moodle 3.3
420      * @param int $courseid Only events in this course
421      * @param null|int $timesortfrom Events after this time (inclusive)
422      * @param null|int $timesortto Events before this time (inclusive)
423      * @param null|int $aftereventid Get events with ids greater than this one
424      * @param int $limitnum Limit the number of results to this value
425      * @return array
426      */
427     public static function get_calendar_action_events_by_course(
428         $courseid, $timesortfrom = null, $timesortto = null, $aftereventid = 0, $limitnum = 20) {
430         global $CFG, $PAGE, $USER;
432         require_once($CFG->dirroot . '/calendar/lib.php');
434         $user = null;
435         $params = self::validate_parameters(
436             self::get_calendar_action_events_by_course_parameters(),
437             [
438                 'courseid' => $courseid,
439                 'timesortfrom' => $timesortfrom,
440                 'timesortto' => $timesortto,
441                 'aftereventid' => $aftereventid,
442                 'limitnum' => $limitnum,
443             ]
444         );
445         $context = \context_user::instance($USER->id);
446         self::validate_context($context);
448         if (empty($params['aftereventid'])) {
449             $params['aftereventid'] = null;
450         }
452         $courses = enrol_get_my_courses('*', 'visible DESC,sortorder ASC', 0, [$courseid]);
453         $courses = array_values($courses);
455         if (empty($courses)) {
456             return [];
457         }
459         $course = $courses[0];
460         $renderer = $PAGE->get_renderer('core_calendar');
461         $events = local_api::get_action_events_by_course(
462             $course,
463             $params['timesortfrom'],
464             $params['timesortto'],
465             $params['aftereventid'],
466             $params['limitnum']
467         );
469         $exportercache = new events_related_objects_cache($events, $courses);
470         $exporter = new events_exporter($events, ['cache' => $exportercache]);
472         return $exporter->export($renderer);
473     }
475     /**
476      * Returns description of method result value.
477      *
478      * @return external_description
479      */
480     public static function get_calendar_action_events_by_course_returns() {
481         return events_exporter::get_read_structure();
482     }
484     /**
485      * Returns description of method parameters.
486      *
487      * @return external_function_parameters
488      */
489     public static function get_calendar_action_events_by_courses_parameters() {
490         return new external_function_parameters(
491             array(
492                 'courseids' => new external_multiple_structure(
493                     new external_value(PARAM_INT, 'Course id')
494                 ),
495                 'timesortfrom' => new external_value(PARAM_INT, 'Time sort from', VALUE_DEFAULT, null),
496                 'timesortto' => new external_value(PARAM_INT, 'Time sort to', VALUE_DEFAULT, null),
497                 'limitnum' => new external_value(PARAM_INT, 'Limit number', VALUE_DEFAULT, 10)
498             )
499         );
500     }
502     /**
503      * Get calendar action events for a given list of courses.
504      *
505      * @since Moodle 3.3
506      * @param array $courseids Only include events for these courses
507      * @param null|int $timesortfrom Events after this time (inclusive)
508      * @param null|int $timesortto Events before this time (inclusive)
509      * @param int $limitnum Limit the number of results per course to this value
510      * @return array
511      */
512     public static function get_calendar_action_events_by_courses(
513         array $courseids, $timesortfrom = null, $timesortto = null, $limitnum = 10) {
515         global $CFG, $PAGE, $USER;
517         require_once($CFG->dirroot . '/calendar/lib.php');
519         $user = null;
520         $params = self::validate_parameters(
521             self::get_calendar_action_events_by_courses_parameters(),
522             [
523                 'courseids' => $courseids,
524                 'timesortfrom' => $timesortfrom,
525                 'timesortto' => $timesortto,
526                 'limitnum' => $limitnum,
527             ]
528         );
529         $context = \context_user::instance($USER->id);
530         self::validate_context($context);
532         if (empty($params['courseids'])) {
533             return ['groupedbycourse' => []];
534         }
536         $renderer = $PAGE->get_renderer('core_calendar');
537         $courses = enrol_get_my_courses('*', 'visible DESC,sortorder ASC', 0, $params['courseids']);
538         $courses = array_values($courses);
540         if (empty($courses)) {
541             return ['groupedbycourse' => []];
542         }
544         $events = local_api::get_action_events_by_courses(
545             $courses,
546             $params['timesortfrom'],
547             $params['timesortto'],
548             $params['limitnum']
549         );
551         if (empty($events)) {
552             return ['groupedbycourse' => []];
553         }
555         $exportercache = new events_related_objects_cache($events, $courses);
556         $exporter = new events_grouped_by_course_exporter($events, ['cache' => $exportercache]);
558         return $exporter->export($renderer);
559     }
561     /**
562      * Returns description of method result value.
563      *
564      * @return external_description
565      */
566     public static function get_calendar_action_events_by_courses_returns() {
567         return events_grouped_by_course_exporter::get_read_structure();
568     }
570     /**
571      * Returns description of method parameters.
572      *
573      * @return external_function_parameters.
574      * @since Moodle 2.5
575      */
576     public static function create_calendar_events_parameters() {
577         // Userid is always current user, so no need to get it from client.
578         // Module based calendar events are not allowed here. Hence no need of instance and modulename.
579         // subscription id and uuid is not allowed as this is not an ical api.
580         return new external_function_parameters(
581                 array('events' => new external_multiple_structure(
582                         new external_single_structure(
583                             array(
584                                 'name' => new external_value(PARAM_TEXT, 'event name', VALUE_REQUIRED, '', NULL_NOT_ALLOWED),
585                                 'description' => new external_value(PARAM_RAW, 'Description', VALUE_DEFAULT, null, NULL_ALLOWED),
586                                 'format' => new external_format_value('description', VALUE_DEFAULT),
587                                 'courseid' => new external_value(PARAM_INT, 'course id', VALUE_DEFAULT, 0, NULL_NOT_ALLOWED),
588                                 'groupid' => new external_value(PARAM_INT, 'group id', VALUE_DEFAULT, 0, NULL_NOT_ALLOWED),
589                                 'repeats' => new external_value(PARAM_INT, 'number of repeats', VALUE_DEFAULT, 0, NULL_NOT_ALLOWED),
590                                 'eventtype' => new external_value(PARAM_TEXT, 'Event type', VALUE_DEFAULT, 'user', NULL_NOT_ALLOWED),
591                                 'timestart' => new external_value(PARAM_INT, 'timestart', VALUE_DEFAULT, time(), NULL_NOT_ALLOWED),
592                                 'timeduration' => new external_value(PARAM_INT, 'time duration', VALUE_DEFAULT, 0, NULL_NOT_ALLOWED),
593                                 'visible' => new external_value(PARAM_INT, 'visible', VALUE_DEFAULT, 1, NULL_NOT_ALLOWED),
594                                 'sequence' => new external_value(PARAM_INT, 'sequence', VALUE_DEFAULT, 1, NULL_NOT_ALLOWED),
595                             ), 'event')
596                 )
597             )
598         );
599     }
601     /**
602      * Delete Calendar events.
603      *
604      * @param array $events A list of events to create.
605      * @return array array of events created.
606      * @since Moodle 2.5
607      * @throws moodle_exception if user doesnt have the permission to create events.
608      */
609     public static function create_calendar_events($events) {
610         global $CFG, $DB, $USER;
611         require_once($CFG->dirroot."/calendar/lib.php");
613         // Parameter validation.
614         $params = self::validate_parameters(self::create_calendar_events_parameters(), array('events' => $events));
616         $transaction = $DB->start_delegated_transaction();
617         $return = array();
618         $warnings = array();
620         foreach ($params['events'] as $event) {
622             // Let us set some defaults.
623             $event['userid'] = $USER->id;
624             $event['modulename'] = '';
625             $event['instance'] = 0;
626             $event['subscriptionid'] = null;
627             $event['uuid']= '';
628             $event['format'] = external_validate_format($event['format']);
629             if ($event['repeats'] > 0) {
630                 $event['repeat'] = 1;
631             } else {
632                 $event['repeat'] = 0;
633             }
635             $eventobj = new calendar_event($event);
637             // Let's check if the user is allowed to delete an event.
638             if (!calendar_add_event_allowed($eventobj)) {
639                 $warnings [] = array('item' => $event['name'], 'warningcode' => 'nopermissions', 'message' => 'you do not have permissions to create this event');
640                 continue;
641             }
642             // Let's create the event.
643             $var = $eventobj->create($event);
644             $var = (array)$var->properties();
645             if ($event['repeat']) {
646                 $children = $DB->get_records('event', array('repeatid' => $var['id']));
647                 foreach ($children as $child) {
648                     $return[] = (array) $child;
649                 }
650             } else {
651                 $return[] = $var;
652             }
653         }
655         // Everything done smoothly, let's commit.
656         $transaction->allow_commit();
657         return array('events' => $return, 'warnings' => $warnings);
658     }
660     /**
661      * Returns description of method result value.
662      *
663      * @return external_description.
664      * @since Moodle 2.5
665      */
666     public static function  create_calendar_events_returns() {
667             return new external_single_structure(
668                     array(
669                         'events' => new external_multiple_structure( new external_single_structure(
670                                 array(
671                                     'id' => new external_value(PARAM_INT, 'event id'),
672                                     'name' => new external_value(PARAM_TEXT, 'event name'),
673                                     'description' => new external_value(PARAM_RAW, 'Description', VALUE_OPTIONAL),
674                                     'format' => new external_format_value('description'),
675                                     'courseid' => new external_value(PARAM_INT, 'course id'),
676                                     'groupid' => new external_value(PARAM_INT, 'group id'),
677                                     'userid' => new external_value(PARAM_INT, 'user id'),
678                                     'repeatid' => new external_value(PARAM_INT, 'repeat id', VALUE_OPTIONAL),
679                                     'modulename' => new external_value(PARAM_TEXT, 'module name', VALUE_OPTIONAL),
680                                     'instance' => new external_value(PARAM_INT, 'instance id'),
681                                     'eventtype' => new external_value(PARAM_TEXT, 'Event type'),
682                                     'timestart' => new external_value(PARAM_INT, 'timestart'),
683                                     'timeduration' => new external_value(PARAM_INT, 'time duration'),
684                                     'visible' => new external_value(PARAM_INT, 'visible'),
685                                     'uuid' => new external_value(PARAM_TEXT, 'unique id of ical events', VALUE_OPTIONAL, '', NULL_NOT_ALLOWED),
686                                     'sequence' => new external_value(PARAM_INT, 'sequence'),
687                                     'timemodified' => new external_value(PARAM_INT, 'time modified'),
688                                     'subscriptionid' => new external_value(PARAM_INT, 'Subscription id', VALUE_OPTIONAL),
689                                 ), 'event')
690                         ),
691                       'warnings' => new external_warnings()
692                     )
693             );
694     }
696     /**
697      * Returns description of method parameters.
698      *
699      * @return external_function_parameters
700      */
701     public static function get_calendar_event_by_id_parameters() {
702         return new external_function_parameters(
703             array(
704                 'eventid' => new external_value(PARAM_INT, 'The event id to be retrieved'),
705             )
706         );
707     }
708     /**
709      * Get calendar event by id.
710      *
711      * @param int $eventid The calendar event id to be retrieved.
712      * @return array Array of event details
713      */
714     public static function get_calendar_event_by_id($eventid) {
715         global $CFG, $PAGE, $USER;
716         require_once($CFG->dirroot."/calendar/lib.php");
718         $params = ['eventid' => $eventid];
719         self::validate_parameters(self::get_calendar_event_by_id_parameters(), $params);
720         $context = \context_user::instance($USER->id);
722         self::validate_context($context);
723         $warnings = array();
725         $legacyevent = calendar_event::load($eventid);
726         $legacyevent->count_repeats();
728         $eventmapper = event_container::get_event_mapper();
729         $event = $eventmapper->from_legacy_event_to_event($legacyevent);
731         $cache = new events_related_objects_cache([$event]);
732         $relatedobjects = [
733             'context' => $cache->get_context($event),
734             'course' => $cache->get_course($event),
735         ];
737         $exporter = new event_exporter($event, $relatedobjects);
738         $renderer = $PAGE->get_renderer('core_calendar');
740         return array('event' => $exporter->export($renderer), 'warnings' => $warnings);
741     }
743     /**
744      * Returns description of method result value
745      *
746      * @return external_description
747      */
748     public static function  get_calendar_event_by_id_returns() {
749         $eventstructure = event_exporter::get_read_structure();
751         return new external_single_structure(array(
752             'event' => $eventstructure,
753             'warnings' => new external_warnings()
754             )
755         );
756     }
758     /**
759      * Returns description of method parameters.
760      *
761      * @return external_function_parameters.
762      */
763     public static function submit_create_update_form_parameters() {
764         return new external_function_parameters(
765             [
766                 'formdata' => new external_value(PARAM_RAW, 'The data from the event form'),
767             ]
768         );
769     }
771     /**
772      * Handles the event form submission.
773      *
774      * @param string $formdata The event form data in a URI encoded param string
775      * @return array The created or modified event
776      * @throws moodle_exception
777      */
778     public static function submit_create_update_form($formdata) {
779         global $CFG, $USER, $PAGE;
780         require_once($CFG->dirroot."/calendar/lib.php");
782         // Parameter validation.
783         $params = self::validate_parameters(self::submit_create_update_form_parameters(), ['formdata' => $formdata]);
784         $context = \context_user::instance($USER->id);
785         $data = [];
787         self::validate_context($context);
788         parse_str($params['formdata'], $data);
790         if (!empty($data['id'])) {
791             $eventid = clean_param($data['id'], PARAM_INT);
792             $legacyevent = calendar_event::load($eventid);
793             $legacyevent->count_repeats();
794             $formoptions = ['event' => $legacyevent];
795             $mform = new update_event_form(null, $formoptions, 'post', '', null, true, $data);
796         } else {
797             $legacyevent = null;
798             $mform = new create_event_form(null, null, 'post', '', null, true, $data);
799         }
801         if ($validateddata = $mform->get_data()) {
802             $formmapper = new create_update_form_mapper();
803             $properties = $formmapper->from_data_to_event_properties($validateddata);
805             if (is_null($legacyevent)) {
806                 $legacyevent = new \calendar_event($properties);
807                 // Need to do this in order to initialise the description
808                 // property which then triggers the update function below
809                 // to set the appropriate default properties on the event.
810                 $properties = $legacyevent->properties(true);
811             }
813             $legacyevent->update($properties);
815             $eventmapper = event_container::get_event_mapper();
816             $event = $eventmapper->from_legacy_event_to_event($legacyevent);
817             $cache = new events_related_objects_cache([$event]);
818             $relatedobjects = [
819                 'context' => $cache->get_context($event),
820                 'course' => $cache->get_course($event),
821             ];
822             $exporter = new event_exporter($event, $relatedobjects);
823             $renderer = $PAGE->get_renderer('core_calendar');
825             return [ 'event' => $exporter->export($renderer) ];
826         } else {
827             return [ 'validationerror' => true ];
828         }
829     }
831     /**
832      * Returns description of method result value.
833      *
834      * @return external_description.
835      */
836     public static function  submit_create_update_form_returns() {
837         $eventstructure = event_exporter::get_read_structure();
838         $eventstructure->required = VALUE_OPTIONAL;
840         return new external_single_structure(
841             array(
842                 'event' => $eventstructure,
843                 'validationerror' => new external_value(PARAM_BOOL, 'Invalid form data', VALUE_DEFAULT, false),
844             )
845         );
846     }