MDL-59750 core_calendar: better handling of event subscription
[moodle.git] / calendar / classes / external / event_exporter.php
CommitLineData
984355ce
RW
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/>.
16
17/**
18 * Contains event class for displaying a calendar event.
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
25namespace core_calendar\external;
26
27defined('MOODLE_INTERNAL') || die();
28
6fb75156
SL
29require_once($CFG->dirroot . "/calendar/lib.php");
30
53cbac18 31use \core_calendar\local\event\entities\action_event_interface;
6fb75156 32use \core_calendar\local\event\container;
984355ce
RW
33use \core_course\external\course_summary_exporter;
34use \renderer_base;
35
36/**
37 * Class for displaying a calendar event.
38 *
39 * @package core_calendar
40 * @copyright 2017 Ryan Wyllie <ryan@moodle.com>
41 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42 */
6ad2bfd1 43class event_exporter extends event_exporter_base {
984355ce
RW
44
45 /**
46 * Return the list of additional properties.
47 *
48 * @return array
49 */
50 protected static function define_other_properties() {
6ad2bfd1
AN
51
52 $values = parent::define_other_properties();
53
6ad2bfd1 54 $values['isactionevent'] = ['type' => PARAM_BOOL];
00d2d344 55 $values['iscourseevent'] = ['type' => PARAM_BOOL];
6ad2bfd1
AN
56 $values['candelete'] = ['type' => PARAM_BOOL];
57 $values['url'] = ['type' => PARAM_URL];
58 $values['action'] = [
59 'type' => event_action_exporter::read_properties_definition(),
60 'optional' => true,
984355ce 61 ];
4c3cd3c1
SL
62 $values['editurl'] = [
63 'type' => PARAM_URL,
64 'optional' => true,
65 ];
a1e166e7
SL
66 $values['groupname'] = [
67 'type' => PARAM_RAW,
68 'optional' => true,
69 'default' => null,
70 'null' => NULL_ALLOWED
71 ];
6ad2bfd1
AN
72
73 return $values;
984355ce
RW
74 }
75
76 /**
77 * Get the additional values to inject while exporting.
78 *
79 * @param renderer_base $output The renderer.
80 * @return array Keys are the property names, values are their values.
81 */
82 protected function get_other_values(renderer_base $output) {
6ad2bfd1
AN
83 $values = parent::get_other_values($output);
84
00d2d344
SL
85 global $CFG;
86 require_once($CFG->dirroot.'/course/lib.php');
87
984355ce
RW
88 $event = $this->event;
89 $context = $this->related['context'];
4df03a27 90 $values['isactionevent'] = false;
00d2d344 91 $values['iscourseevent'] = false;
cd2c4b85
MG
92 if ($moduleproxy = $event->get_course_module()) {
93 $modulename = $moduleproxy->get('modname');
94 $moduleid = $moduleproxy->get('id');
95 $url = new \moodle_url(sprintf('/mod/%s/view.php', $modulename), ['id' => $moduleid]);
c34e2002 96
4df03a27 97 $values['isactionevent'] = true;
c34e2002
SL
98
99 // Build edit event url for action events.
100 $params = array('update' => $moduleid, 'return' => true, 'sesskey' => sesskey());
101 $editurl = new \moodle_url('/course/mod.php', $params);
102 $values['editurl'] = $editurl->out(false);
00d2d344
SL
103 } else if ($event->get_type() == 'course') {
104 $values['iscourseevent'] = true;
105 $url = \course_get_url($this->related['course'] ?: SITEID);
cd2c4b85
MG
106 } else {
107 // TODO MDL-58866 We do not have any way to find urls for events outside of course modules.
cd2c4b85
MG
108 $url = \course_get_url($this->related['course'] ?: SITEID);
109 }
984355ce 110 $values['url'] = $url->out(false);
984355ce
RW
111
112 if ($event instanceof action_event_interface) {
6b7b39fe
JP
113 $actionrelated = [
114 'context' => $context,
115 'event' => $event
116 ];
117 $actionexporter = new event_action_exporter($event->get_action(), $actionrelated);
984355ce
RW
118 $values['action'] = $actionexporter->export($output);
119 }
120
121 if ($course = $this->related['course']) {
122 $coursesummaryexporter = new course_summary_exporter($course, ['context' => $context]);
123 $values['course'] = $coursesummaryexporter->export($output);
124 }
4df03a27 125
28e030d9
RW
126 if ($group = $event->get_group()) {
127 $values['groupname'] = format_string($group->get('name'), true,
128 ['context' => \context_course::instance($event->get_course()->get('id'))]);
a1e166e7
SL
129 }
130
6ad2bfd1 131 return $values;
984355ce
RW
132 }
133}