-
Notifications
You must be signed in to change notification settings - Fork 2
/
renderer.php
378 lines (328 loc) · 13.7 KB
/
renderer.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Renderer code for messages in full and short (block) layouts.
*
* @package block_news
* @copyright 2014 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
if (!defined('MOODLE_INTERNAL')) {
die('Direct access to this script is forbidden.');
}
/**
* Full message class (for display in the single message or all messages pages).
*
* @package block_news
*/
class block_news_message_full implements renderable {
/**
* Build full message data
*
* @param block_news_message $bnm
* @param integer $previd
* @param integer $nextid
* @param block_news_system $bns
* @param string $mode
*/
public function __construct($bnm, $previd, $nextid, $bns, $mode) {
global $CFG;
$this->classes = '';
$this->notes = array();
if ($bns->get_hidetitles()) {
$this->title = '';
} else {
$this->title = $bnm->get_title();
}
if ($bns->get_hidelinks()) {
$this->link = '';
} else {
$this->link = $bnm->get_link();
}
$this->viewlink = $bnm->get_link();
$this->message = $bnm->get_message();
$this->messagedate = userdate($bnm->get_messagedate(),
get_string('dateformat', 'block_news'));
$this->messagevisible = $bnm->get_messagevisible();
$usr = $bnm->get_user();
if ($bnm->get_hideauthor() || $usr == null) {
$this->author = '';
} else {
$this->author = fullname($usr);
}
if ($bnm->is_visible_to_students()) {
$this->classes .= ' msgvis';
$this->showhideact = 'hide'; // 'wrong way round'
} else {
$this->classes .= ' msghide';
$this->showhideact = 'hide';
if (!$bnm->get_messagevisible()) {
$this->notes[] = get_string('rendermsghidden', 'block_news');
$this->showhideact = 'show';
}
if ($bnm->get_messagedate() > time()) {
$this->notes[] = get_string('rendermsgfuture', 'block_news',
userdate($bnm->get_messagedate(), get_string('dateformatlong', 'block_news')));
}
}
if ($mode == 'one') { // single message
if ($previd == -1) {
$this->prevurl = 'end';
} else {
$this->prevurl = $CFG->wwwroot . '/blocks/news/message.php?m=' . $previd;
}
if ($nextid == -1) {
$this->nexturl = 'end';
} else {
$this->nexturl = $CFG->wwwroot.'/blocks/news/message.php?m=' . $nextid;
}
} else if ($mode == 'all') { // all messages - dont display prev/next links
$this->prevurl = null;
$this->nexturl = null;
} else {
print_error('errorinvalidmode', 'block_news', $mode);
}
// if a feed message (newsfeedid != 0) dont show edit etc icons
if ($bnm->get_newsfeedid() == 0) {
// context for access checks
$blockcontext = context_block::instance($bnm->get_blockinstanceid());
if (has_capability('block/news:hide', $blockcontext)) {
$this->hideicon = new pix_icon('t/' . $this->showhideact, $this->showhideact);
// eg 't/hide', 'hide'
$this->hideurl = $CFG->wwwroot . '/blocks/news/message.php?m=' . $bnm->get_id()
. '&action=hide&mode=' . $mode;
}
if (has_capability('block/news:add', $blockcontext)) {
$this->editicon = new pix_icon('t/edit', 'edit');
$this->editurl = $CFG->wwwroot . '/blocks/news/edit.php?m=' . $bnm->get_id()
. '&mode=' . $mode;
}
if (has_capability('block/news:delete', $blockcontext)) {
$this->deleteicon = new pix_icon('t/delete', 'delete');
$this->deleteurl = $CFG->wwwroot.'/blocks/news/message.php?m=' . $bnm->get_id()
. '&action=delete&mode=' . $mode;
}
}
// FOR ATTACHMENTS
$this->blockinstanceid = $bnm->get_blockinstanceid();
$this->messageformat = $bnm->get_messageformat();
$this->id = $bnm->get_id();
}
}
/**
* Short message class (for display in the block).
*
* @package block_news
*/
class block_news_message_short implements renderable {
/**
* Build short message data
*
* @param block_news_message $bnm
* @param block_news_system $bns
* @param int $summarylength Length of text displayed (0 = none)
* @param int $count Sequence, eg 1 is first message in the block
*/
public function __construct($bnm, $bns, $summarylength, $count) {
global $CFG;
$this->classes = '';
if ($bns->get_hidetitles()) {
$this->title = '';
} else {
$this->title = $bnm->get_title();
}
if ($bns->get_hidelinks()) {
$this->link = '';
} else {
$this->link = $bnm->get_link();
}
$this->viewlink = $CFG->wwwroot . '/blocks/news/message.php?m=' . $bnm->get_id();
if ($summarylength) {
$this->message = shorten_text(strip_tags($bnm->get_message()), $summarylength);
} else {
$this->message = '';
}
$this->messagedate = userdate($bnm->get_messagedate(),
get_string('dateformat', 'block_news'));
$this->messagevisible = $bnm->get_messagevisible();
$this->messageformat = $bnm->get_messageformat();
$usr = $bnm->get_user();
if ($bnm->get_hideauthor() || $usr == null) {
$this->author = '';
} else {
$this->author = fullname($usr);
}
}
}
/**
* Main renderer.
*
* @package block_news
*/
class block_news_renderer extends plugin_renderer_base {
/**
* Wrapper hook for news messages start
*/
public function open_news_block_custom_wrapper() {
return '';
}
/**
* Wrapper hook for news messages end
*/
public function close_news_block_custom_wrapper() {
return '';
}
/**
* Generate HTML for full message
* @param block_news_message_full $nmsg Renderable data
* @return string HTML
*/
protected function render_block_news_message_full(block_news_message_full $nmsg) {
global $CFG;
require_once($CFG->libdir . '/filelib.php');
$blockcontext = context_block::instance($nmsg->blockinstanceid);
$nmsg->message = file_rewrite_pluginfile_urls($nmsg->message, 'pluginfile.php',
$blockcontext->id, 'block_news', 'message', $nmsg->id);
$out = '';
// Link to previous message (outside box).
if ($nmsg->prevurl && $nmsg->prevurl !== 'end') {
$out .= $this->output->container_start('prevlink');
$out .= link_arrow_left(get_string('rendermsgprev', 'block_news'),
$nmsg->prevurl);
$out .= $this->output->container_end();
}
// Start main message box.
$out .= $this->output->container_start('main');
$out .= $this->output->box($nmsg->messagedate, 'messagedate ' . $nmsg->classes);
$out .= $this->output->box(format_string($nmsg->title), 'title ' . $nmsg->classes);
if (!empty($nmsg->link)) {
$out .= $this->output->box_start('link');
$out .= $this->output->action_link($nmsg->link, $nmsg->link);
$out .= $this->output->box_end('link');
}
$out .= $this->output->container(format_string($nmsg->author), 'author ' . $nmsg->classes);
$out .= $this->output->container(format_text($nmsg->message, $nmsg->messageformat),
'message ' . $nmsg->classes);
// attached files
$fs = get_file_storage();
$files = $fs->get_area_files($blockcontext->id, 'block_news', 'attachment',
$nmsg->id, "timemodified", false);
if ($files) {
$out .= html_writer::start_tag('div', array('class' => 'news-message-attachments'));
$out .= html_writer::tag('h3', get_string('msgedithlpattach', 'block_news'), null);
$out .= html_writer::start_tag('ul');
foreach ($files as $file) {
$out .= html_writer::start_tag('li');
$filename = $file->get_filename();
$mimetype = $file->get_mimetype();
$iconimage = html_writer::empty_tag('img',
array('src' => $this->output->pix_url(file_mimetype_icon($mimetype)),
'alt' => $mimetype, 'class' => 'icon'));
$path = moodle_url::make_pluginfile_url($blockcontext->id, 'block_news',
'attachment', $nmsg->id, '/', $filename, true);
$out .= html_writer::tag('a', $iconimage, array('href' => $path));
$out .= html_writer::tag('a', s($filename), array('href' => $path));
$out .= html_writer::end_tag('li');
}
$out .= html_writer::end_tag('ul');
$out .= html_writer::end_tag('div');
}
$out .= $this->output->box_start(null, 'editicons');
if (isset($nmsg->hideicon) && isset($nmsg->hideurl)) {
$out .= $this->output->container_start('', 'hideurl');
$out .= $this->output->action_icon($nmsg->hideurl, $nmsg->hideicon);
$out .= $this->output->container_end();
}
if (isset($nmsg->editicon) && isset($nmsg->editurl)) {
$out .= $this->output->container_start('', 'editurl');
$out .= $this->output->action_icon($nmsg->editurl, $nmsg->editicon);
$out .= $this->output->container_end();
}
if (isset($nmsg->deleteicon) && isset($nmsg->deleteurl)) {
$out .= $this->output->container_start('', 'deleteurl');
$out .= $this->output->action_icon($nmsg->deleteurl, $nmsg->deleteicon);
$out .= $this->output->container_end();
}
$out .= $this->output->box_end(null, 'editicons');
$out .= $this->output->box_start(null, 'notes');
foreach ($nmsg->notes as $note) {
$out .= $this->output->container($note, 'note ');
}
$out .= $this->output->box_end(null, 'notes');
$out .= $this->output->container_end();
if ($nmsg->nexturl && $nmsg->nexturl !== 'end') {
$out .= $this->output->container_start('nextlink');
$out .= link_arrow_right(get_string('rendermsgnext', 'block_news'),
$nmsg->nexturl);
$out .= $this->output->container_end();
}
return $this->output->container($out, 'block_news_message ' . $nmsg->classes);
}
/**
* @param string $date News date
* @param string $title News title
* @return string HTML code for displaying the news heading.
*/
protected function render_block_news_message_heading($date, $title) {
return $this->output->heading($date . ' ' . $title, 3);
}
/**
* @param moodle_url $url URL of the view link
* @return string HTML code for displaying the view link.
*/
protected function render_block_news_message_link($url, $extralinktext = '') {
return $this->output->action_link($url,
get_string('rendermsgview', 'block_news') . $extralinktext);
}
/**
* @param block_news_message_short $nmsg Renderable data
* @return string HTML
*/
protected function render_block_news_message_short(block_news_message_short $nmsg) {
global $CFG;
$out = '';
$out .= $this->output->container_start('block_news_msg');
$date = html_writer::tag('span', $nmsg->messagedate,
array('class' => 'block_news_msg_messagedate'));
$title = html_writer::tag('span', format_string($nmsg->title),
array('class' => 'block_news_msg_title'));
if (!empty($nmsg->link)) {
$title = $this->output->action_link($nmsg->link, $title);
}
$out .= $this->render_block_news_message_heading($date, $title);
if (!empty($nmsg->author)) {
$out .= $this->output->container(format_string($nmsg->author),
'block_news_msg_author');
}
$out .= $this->output->container(format_text($nmsg->message, $nmsg->messageformat),
'block_news_msg_message');
// (View)
$out .= $this->output->container_start('link');
$accesshidetxt = html_writer::tag('span', ' ' . $nmsg->title, array('class' => 'accesshide'));
$out .= $this->render_block_news_message_link($nmsg->viewlink, $accesshidetxt);
$out .= $this->output->container_end();
$out .= $this->output->container_end();
return $this->output->container($out, 'block_news '.$nmsg->classes);
}
/**
* Adds (new) to the News block title if there are new messages
* @param string $newstitle News block title
* @return string text
*/
public function render_block_news_new_messages($newstitle) {
return $newstitle . ' ('.get_string('new', 'block_news') . ')';
}
}