MDL-58474 core_calendar: add missing action_event_interface import
[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 use \core\external\exporter;
30 use \core_calendar\local\event\entities\event_interface;
31 use \core_calendar\local\event\entities\action_event_interface;
32 use \core_course\external\course_summary_exporter;
33 use \renderer_base;
35 /**
36  * Class for displaying a calendar event.
37  *
38  * @package   core_calendar
39  * @copyright 2017 Ryan Wyllie <ryan@moodle.com>
40  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class event_exporter extends exporter {
44     /**
45      * @var event_interface $event
46      */
47     protected $event;
49     /**
50      * Constructor.
51      *
52      * @param event_interface $event
53      * @param array $related The related data.
54      */
55     public function __construct(event_interface $event, $related = []) {
56         $this->event = $event;
58         $starttimestamp = $event->get_times()->get_start_time()->getTimestamp();
59         $endtimestamp = $event->get_times()->get_end_time()->getTimestamp();
60         $groupid = $event->get_group() ? $event->get_group()->get('id') : null;
61         $userid = $event->get_user() ? $event->get_user()->get('id') : null;
63         $data = new \stdClass();
64         $data->id = $event->get_id();
65         $data->name = $event->get_name();
66         $data->description = $event->get_description()->get_value();
67         $data->descriptionformat = $event->get_description()->get_format();
68         $data->groupid = $groupid;
69         $data->userid = $userid;
70         $data->eventtype = $event->get_type();
71         $data->timestart = $starttimestamp;
72         $data->timeduration = $endtimestamp - $starttimestamp;
73         $data->timesort = $event->get_times()->get_sort_time()->getTimestamp();
74         $data->visible = $event->is_visible();
75         $data->timemodified = $event->get_times()->get_modified_time()->getTimestamp();
77         if ($repeats = $event->get_repeats()) {
78             $data->repeatid = $repeats->get_id();
79         }
81         if ($cm = $event->get_course_module()) {
82             $data->modulename = $cm->get('modname');
83             $data->instance = $cm->get('id');
84         }
86         parent::__construct($data, $related);
87     }
89     /**
90      * Return the list of properties.
91      *
92      * @return array
93      */
94     protected static function define_properties() {
95         return [
96             'id' => ['type' => PARAM_INT],
97             'name' => ['type' => PARAM_TEXT],
98             'description' => [
99                 'type' => PARAM_RAW,
100                 'optional' => true,
101                 'default' => null,
102                 'null' => NULL_ALLOWED
103             ],
104             'descriptionformat' => [
105                 'type' => PARAM_INT,
106                 'optional' => true,
107                 'default' => null,
108                 'null' => NULL_ALLOWED
109             ],
110             'groupid' => [
111                 'type' => PARAM_INT,
112                 'optional' => true,
113                 'default' => null,
114                 'null' => NULL_ALLOWED
115             ],
116             'userid' => [
117                 'type' => PARAM_INT,
118                 'optional' => true,
119                 'default' => null,
120                 'null' => NULL_ALLOWED
121             ],
122             'repeatid' => [
123                 'type' => PARAM_INT,
124                 'optional' => true,
125                 'default' => null,
126                 'null' => NULL_ALLOWED
127             ],
128             'modulename' => [
129                 'type' => PARAM_TEXT,
130                 'optional' => true,
131                 'default' => null,
132                 'null' => NULL_ALLOWED
133             ],
134             'instance' => [
135                 'type' => PARAM_INT,
136                 'optional' => true,
137                 'default' => null,
138                 'null' => NULL_ALLOWED
139             ],
140             'eventtype' => ['type' => PARAM_TEXT],
141             'timestart' => ['type' => PARAM_INT],
142             'timeduration' => ['type' => PARAM_INT],
143             'timesort' => ['type' => PARAM_INT],
144             'visible' => ['type' => PARAM_INT],
145             'timemodified' => ['type' => PARAM_INT],
146         ];
147     }
149     /**
150      * Return the list of additional properties.
151      *
152      * @return array
153      */
154     protected static function define_other_properties() {
155         return [
156             'url' => ['type' => PARAM_URL],
157             'icon' => [
158                 'type' => event_icon_exporter::read_properties_definition(),
159             ],
160             'action' => [
161                 'type' => event_action_exporter::read_properties_definition(),
162                 'optional' => true,
163             ],
164             'course' => [
165                 'type' => course_summary_exporter::read_properties_definition(),
166                 'optional' => true,
167             ]
168         ];
169     }
171     /**
172      * Get the additional values to inject while exporting.
173      *
174      * @param renderer_base $output The renderer.
175      * @return array Keys are the property names, values are their values.
176      */
177     protected function get_other_values(renderer_base $output) {
178         $values = [];
179         $event = $this->event;
180         $context = $this->related['context'];
181         $modulename = $event->get_course_module()->get('modname');
182         $moduleid = $event->get_course_module()->get('id');
183         $timesort = $event->get_times()->get_sort_time()->getTimestamp();
184         $url = new \moodle_url(sprintf('/mod/%s/view.php', $modulename), ['id' => $moduleid]);
185         $iconexporter = new event_icon_exporter($event, ['context' => $context]);
187         $values['url'] = $url->out(false);
188         $values['icon'] = $iconexporter->export($output);
190         if ($event instanceof action_event_interface) {
191             $actionrelated = [
192                 'context' => $context,
193                 'event' => $event
194             ];
195             $actionexporter = new event_action_exporter($event->get_action(), $actionrelated);
196             $values['action'] = $actionexporter->export($output);
197         }
199         if ($course = $this->related['course']) {
200             $coursesummaryexporter = new course_summary_exporter($course, ['context' => $context]);
201             $values['course'] = $coursesummaryexporter->export($output);
202         }
204         return $values;
205     }
207     /**
208      * Returns a list of objects that are related.
209      *
210      * @return array
211      */
212     protected static function define_related() {
213         return [
214             'context' => 'context',
215             'course' => 'stdClass?',
216         ];
217     }