Moodle release 3.7rc1
[moodle.git] / mod / forum / classes / local / exporters / discussion.php
CommitLineData
47d38303
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 * Discussion exporter class.
19 *
20 * @package mod_forum
21 * @copyright 2019 Ryan Wyllie <ryan@moodle.com>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace mod_forum\local\exporters;
26
27defined('MOODLE_INTERNAL') || die();
28
29use mod_forum\local\entities\discussion as discussion_entity;
30use mod_forum\local\exporters\post as post_exporter;
31use mod_forum\local\factories\exporter as exporter_factory;
32use core\external\exporter;
33use renderer_base;
34
35/**
36 * Discussion exporter class.
37 *
38 * @copyright 2019 Ryan Wyllie <ryan@moodle.com>
39 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40 */
41class discussion extends exporter {
42 /** @var discussion_entity $discussion Discussion to export */
43 private $discussion;
44
45 /**
46 * Constructor.
47 *
48 * @param discussion_entity $discussion Discussion to export
49 * @param array $related The related export data
50 */
51 public function __construct(discussion_entity $discussion, array $related = []) {
52 $this->discussion = $discussion;
53
54 return parent::__construct([], $related);
55 }
56
57 /**
58 * Return the list of additional properties.
59 *
60 * @return array
61 */
62 protected static function define_other_properties() {
63 return [
64 'id' => ['type' => PARAM_INT],
65 'forumid' => ['type' => PARAM_INT],
66 'pinned' => ['type' => PARAM_BOOL],
bdb4a87d
P
67 'locked' => ['type' => PARAM_BOOL],
68 'istimelocked' => ['type' => PARAM_BOOL],
47d38303 69 'name' => ['type' => PARAM_TEXT],
1a9c60e9 70 'firstpostid' => ['type' => PARAM_INT],
47d38303
RW
71 'group' => [
72 'optional' => true,
73 'type' => [
74 'name' => ['type' => PARAM_TEXT],
75 'urls' => [
76 'type' => [
77 'picture' => [
78 'optional' => true,
79 'type' => PARAM_URL,
80 ],
81 'userlist' => [
82 'optional' => true,
83 'type' => PARAM_URL,
84 ],
85 ],
86 ],
87 ],
88 ],
89 'times' => [
90 'type' => [
91 'modified' => ['type' => PARAM_INT],
92 'start' => ['type' => PARAM_INT],
93 'end' => ['type' => PARAM_INT],
2893812e 94 'locked' => ['type' => PARAM_INT],
47d38303
RW
95 ],
96 ],
97 'userstate' => [
98 'type' => [
99 'subscribed' => ['type' => PARAM_BOOL],
99bda8a7 100 'favourited' => ['type' => PARAM_BOOL],
47d38303
RW
101 ],
102 ],
103 'capabilities' => [
104 'type' => [
105 'subscribe' => ['type' => PARAM_BOOL],
106 'move' => ['type' => PARAM_BOOL],
107 'pin' => ['type' => PARAM_BOOL],
2893812e
P
108 'post' => ['type' => PARAM_BOOL],
109 'manage' => ['type' => PARAM_BOOL],
99bda8a7 110 'favourite' => ['type' => PARAM_BOOL]
47d38303
RW
111 ]
112 ],
113 'urls' => [
114 'type' => [
115 'view' => ['type' => PARAM_URL],
116 'viewlatest' => [
117 'optional' => true,
118 'type' => PARAM_URL
119 ],
120 'viewfirstunread' => [
121 'optional' => true,
122 'type' => PARAM_URL,
123 ],
124 'markasread' => ['type' => PARAM_URL],
e7e6a721
P
125 'subscribe' => ['type' => PARAM_URL],
126 'pin' => [
127 'optional' => true,
128 'type' => PARAM_URL,
129 ],
47d38303 130 ],
7661ccdd
MG
131 ],
132 'timed' => [
133 'type' => [
134 'istimed' => [
135 'type' => PARAM_BOOL,
136 'optional' => true,
137 'default' => null,
138 'null' => NULL_ALLOWED
139 ],
140 'visible' => [
141 'type' => PARAM_BOOL,
142 'optional' => true,
143 'default' => null,
144 'null' => NULL_ALLOWED
145 ]
146 ]
47d38303
RW
147 ]
148 ];
149 }
150
151 /**
152 * Get the additional values to inject while exporting.
153 *
154 * @param renderer_base $output The renderer.
155 * @return array Keys are the property names, values are their values.
156 */
157 protected function get_other_values(renderer_base $output) {
7661ccdd 158
47d38303
RW
159 $capabilitymanager = $this->related['capabilitymanager'];
160 $urlfactory = $this->related['urlfactory'];
13cd05ac 161 $favouriteids = isset($this->related['favouriteids']) ? $this->related['favouriteids'] : [];
47d38303
RW
162
163 $forum = $this->related['forum'];
164 $forumrecord = $this->get_forum_record();
165 $user = $this->related['user'];
166 $discussion = $this->discussion;
167
168 $groupdata = null;
169 if ($discussion->has_group() && $group = $this->related['groupsbyid'][$discussion->get_group_id()]) {
170 $groupdata = [
171 'name' => $group->name,
172 'urls' => [],
173 ];
174 $canviewparticipants = $capabilitymanager->can_view_participants($user, $discussion);
175 if (!$group->hidepicture) {
176 $url = get_group_picture_url($group, $forum->get_course_id());
177 if (!empty($url)) {
178 $groupdata['urls']['picture'] = $url;
179 }
180 }
181 if ($canviewparticipants) {
182 $groupdata['urls']['userlist'] = (new \moodle_url('/user/index.php', [
183 'id' => $forum->get_course_id(),
184 'group' => $group->id,
185 ]));
186 }
187 }
188
189 $viewfirstunreadurl = $urlfactory->get_discussion_view_first_unread_post_url_from_discussion($discussion);
190 $data = [
191 'id' => $discussion->get_id(),
192 'forumid' => $forum->get_id(),
193 'pinned' => $discussion->is_pinned(),
bdb4a87d
P
194 'locked' => $forum->is_discussion_locked($discussion),
195 'istimelocked' => $forum->is_discussion_time_locked($discussion),
47d38303
RW
196 'name' => format_string($discussion->get_name(), true, [
197 'context' => $this->related['context']
198 ]),
1a9c60e9 199 'firstpostid' => $discussion->get_first_post_id(),
47d38303
RW
200 'times' => [
201 'modified' => $discussion->get_time_modified(),
202 'start' => $discussion->get_time_start(),
203 'end' => $discussion->get_time_end(),
2893812e 204 'locked' => $discussion->get_locked()
47d38303
RW
205 ],
206 'userstate' => [
99bda8a7 207 'subscribed' => \mod_forum\subscriptions::is_subscribed($user->id, $forumrecord, $discussion->get_id()),
13cd05ac 208 'favourited' => in_array($discussion->get_id(), $favouriteids) ? true : false,
47d38303
RW
209 ],
210 'capabilities' => [
211 'subscribe' => $capabilitymanager->can_subscribe_to_discussion($user, $discussion),
212 'move' => $capabilitymanager->can_move_discussion($user, $discussion),
213 'pin' => $capabilitymanager->can_pin_discussion($user, $discussion),
2893812e 214 'post' => $capabilitymanager->can_post_in_discussion($user, $discussion),
99bda8a7 215 'manage' => $capabilitymanager->can_manage_forum($user),
b4a1bbbb 216 'favourite' => $capabilitymanager->can_favourite_discussion($user) // Defaulting to true until we get capabilities sorted
47d38303
RW
217 ],
218 'urls' => [
219 'view' => $urlfactory->get_discussion_view_url_from_discussion($discussion)->out(false),
220 'viewfirstunread' => $viewfirstunreadurl->out(false),
221 'markasread' => $urlfactory->get_mark_discussion_as_read_url_from_discussion($forum, $discussion)->out(false),
b4d47dec 222 'subscribe' => $urlfactory->get_discussion_subscribe_url($discussion)->out(false)
47d38303
RW
223 ]
224 ];
225
226 if (!empty($this->related['latestpostid'])) {
227 $data['urls']['viewlatest'] = $urlfactory->get_discussion_view_latest_post_url_from_discussion(
228 $discussion,
229 $this->related['latestpostid']
230 )->out(false);
231 }
232
e7e6a721
P
233 if ($capabilitymanager->can_pin_discussions($user)) {
234 $data['urls']['pin'] = $urlfactory->get_pin_discussion_url_from_discussion($discussion)->out(false);
235 }
236
47d38303
RW
237 if ($groupdata) {
238 $data['group'] = $groupdata;
239 }
240
7661ccdd
MG
241 $canviewhiddentimedposts = $capabilitymanager->can_view_hidden_posts($user);
242 $canalwaysseetimedpost = $user->id == $discussion->get_user_id() || $canviewhiddentimedposts;
243 $data['timed']['istimed'] = $canalwaysseetimedpost ? $discussion->is_timed_discussion() : null;
244 $data['timed']['visible'] = $canalwaysseetimedpost ? $discussion->is_timed_discussion_visible() : null;
245
47d38303
RW
246 return $data;
247 }
248
249 /**
250 * Get the legacy forum record from the forum entity.
251 *
252 * @return stdClass
253 */
254 private function get_forum_record() {
255 $forumdbdatamapper = $this->related['legacydatamapperfactory']->get_forum_data_mapper();
256 return $forumdbdatamapper->to_legacy_object($this->related['forum']);
257 }
258
259 /**
260 * Returns a list of objects that are related.
261 *
262 * @return array
263 */
264 protected static function define_related() {
265 return [
266 'legacydatamapperfactory' => 'mod_forum\local\factories\legacy_data_mapper',
267 'context' => 'context',
268 'forum' => 'mod_forum\local\entities\forum',
269 'capabilitymanager' => 'mod_forum\local\managers\capability',
270 'urlfactory' => 'mod_forum\local\factories\url',
271 'user' => 'stdClass',
272 'groupsbyid' => 'stdClass[]',
13cd05ac
P
273 'latestpostid' => 'int?',
274 'favouriteids' => 'int[]?'
47d38303
RW
275 ];
276 }
277}