Merge branch 'MDL-59393-master-2' of git://github.com/ryanwyllie/moodle
[moodle.git] / calendar / classes / external / event_exporter.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  * 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  */
25 namespace core_calendar\external;
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->dirroot . "/calendar/lib.php");
31 use \core_calendar\local\event\entities\action_event_interface;
32 use \core_calendar\local\event\container;
33 use \core_course\external\course_summary_exporter;
34 use \renderer_base;
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  */
43 class event_exporter extends event_exporter_base {
45     /**
46      * Return the list of additional properties.
47      *
48      * @return array
49      */
50     protected static function define_other_properties() {
52         $values = parent::define_other_properties();
54         $values['displayeventsource'] = ['type' => PARAM_BOOL];
55         $values['subscription'] = [
56             'type' => PARAM_RAW,
57             'optional' => true,
58             'default' => null,
59             'null' => NULL_ALLOWED
60         ];
61         $values['isactionevent'] = ['type' => PARAM_BOOL];
62         $values['iscourseevent'] = ['type' => PARAM_BOOL];
63         $values['candelete'] = ['type' => PARAM_BOOL];
64         $values['url'] = ['type' => PARAM_URL];
65         $values['action'] = [
66             'type' => event_action_exporter::read_properties_definition(),
67             'optional' => true,
68         ];
69         $values['editurl'] = [
70             'type' => PARAM_URL,
71             'optional' => true,
72         ];
73         $values['groupname'] = [
74             'type' => PARAM_RAW,
75             'optional' => true,
76             'default' => null,
77             'null' => NULL_ALLOWED
78         ];
80         return $values;
81     }
83     /**
84      * Get the additional values to inject while exporting.
85      *
86      * @param renderer_base $output The renderer.
87      * @return array Keys are the property names, values are their values.
88      */
89     protected function get_other_values(renderer_base $output) {
90         $values = parent::get_other_values($output);
92         global $CFG;
93         require_once($CFG->dirroot.'/course/lib.php');
95         $event = $this->event;
96         $context = $this->related['context'];
97         $values['isactionevent'] = false;
98         $values['iscourseevent'] = false;
99         if ($moduleproxy = $event->get_course_module()) {
100             $modulename = $moduleproxy->get('modname');
101             $moduleid = $moduleproxy->get('id');
102             $url = new \moodle_url(sprintf('/mod/%s/view.php', $modulename), ['id' => $moduleid]);
104             $values['isactionevent'] = true;
106             // Build edit event url for action events.
107             $params = array('update' => $moduleid, 'return' => true, 'sesskey' => sesskey());
108             $editurl = new \moodle_url('/course/mod.php', $params);
109             $values['editurl'] = $editurl->out(false);
110         } else if ($event->get_type() == 'course') {
111             $values['iscourseevent'] = true;
112             $url = \course_get_url($this->related['course'] ?: SITEID);
113         } else {
114             // TODO MDL-58866 We do not have any way to find urls for events outside of course modules.
115             $url = \course_get_url($this->related['course'] ?: SITEID);
116         }
117         $values['url'] = $url->out(false);
119         if ($event instanceof action_event_interface) {
120             $actionrelated = [
121                 'context' => $context,
122                 'event' => $event
123             ];
124             $actionexporter = new event_action_exporter($event->get_action(), $actionrelated);
125             $values['action'] = $actionexporter->export($output);
126         }
128         if ($course = $this->related['course']) {
129             $coursesummaryexporter = new course_summary_exporter($course, ['context' => $context]);
130             $values['course'] = $coursesummaryexporter->export($output);
131         }
133         // Handle event subscription.
134         $values['subscription'] = null;
135         $values['displayeventsource'] = false;
136         if ($event->get_subscription()) {
137             $subscription = calendar_get_subscription($event->get_subscription()->get('id'));
138             if (!empty($subscription) && $CFG->calendar_showicalsource) {
139                 $values['displayeventsource'] = true;
140                 $subscriptiondata = new \stdClass();
141                 if (!empty($subscription->url)) {
142                     $subscriptiondata->url = $subscription->url;
143                 }
144                 $subscriptiondata->name = $subscription->name;
145                 $values['subscription'] = json_encode($subscriptiondata);
146             }
147         }
149         if ($group = $event->get_group()) {
150             $values['groupname'] = format_string($group->get('name'), true,
151                 ['context' => \context_course::instance($event->get_course()->get('id'))]);
152         }
154         return $values;
155     }