MDL-18375 calendar: added multiple calendar support
[moodle.git] / calendar / renderer.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This file contains the renderers for the calendar within Moodle
20  *
21  * @copyright 2010 Sam Hemelryk
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package calendar
24  */
26 if (!defined('MOODLE_INTERNAL')) {
27     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
28 }
30 /**
31  * The primary renderer for the calendar.
32  */
33 class core_calendar_renderer extends plugin_renderer_base {
35     /**
36      * Creates a basic export form
37      *
38      * @param bool $allowthisweek
39      * @param bool $allownextweek
40      * @param bool $allownextmonth
41      * @param int $userid
42      * @param string $authtoken
43      * @return string
44      */
45     public function basic_export_form($allowthisweek, $allownextweek, $allownextmonth, $userid, $authtoken) {
46         global $CFG;
48         $output  = html_writer::tag('div', get_string('export', 'calendar'), array('class'=>'header'));
49         $output .= html_writer::start_tag('fieldset');
50         $output .= html_writer::tag('legend', get_string('commontasks', 'calendar'));
51         $output .= html_writer::start_tag('form', array('action'=>new moodle_url('/calendar/export_execute.php'), 'method'=>'get'));
53         $output .= html_writer::tag('div', get_string('iwanttoexport', 'calendar'));
55         $output .= html_writer::start_tag('div', array('class'=>'indent'));
56         $output .= html_writer::empty_tag('input', array('type'=>'radio', 'name'=>'preset_what', 'id'=>'pw_all', 'value'=>'all', 'checked'=>'checked'));
57         $output .= html_writer::tag('label', get_string('eventsall', 'calendar'), array('for'=>'pw_all'));
58         $output .= html_writer::empty_tag('br');
59         $output .= html_writer::empty_tag('input', array('type'=>'radio', 'name'=>'preset_what', 'id'=>'pw_course', 'value'=>'courses'));
60         $output .= html_writer::tag('label', get_string('eventsrelatedtocourses', 'calendar'), array('for'=>'pw_course'));
61         $output .= html_writer::empty_tag('br');
62         $output .= html_writer::end_tag('div');
64         $output .= html_writer::tag('div', get_string('for', 'calendar').':');
66         $output .= html_writer::start_tag('div', array('class'=>'indent'));
67         if ($allowthisweek) {
68             $output .= html_writer::empty_tag('input', array('type'=>'radio', 'name'=>'preset_time', 'id'=>'pt_wknow', 'value'=>'weeknow', 'checked'=>'checked'));
69             $output .= html_writer::tag('label', get_string('weekthis', 'calendar'), array('for'=>'pt_wknow'));
70             $output .= html_writer::empty_tag('br');
71         }
72         if ($allownextweek) {
73             $output .= html_writer::empty_tag('input', array('type'=>'radio', 'name'=>'preset_time', 'id'=>'pt_wknext', 'value'=>'weeknext'));
74             $output .= html_writer::tag('label', get_string('weeknext', 'calendar'), array('for'=>'pt_wknext'));
75             $output .= html_writer::empty_tag('br');
76         }
77         $output .= html_writer::empty_tag('input', array('type'=>'radio', 'name'=>'preset_time', 'id'=>'pt_monnow', 'value'=>'monthnow'));
78         $output .= html_writer::tag('label', get_string('monththis', 'calendar'), array('for'=>'pt_monnow'));
79         $output .= html_writer::empty_tag('br');
80         if ($allownextmonth) {
81             $output .= html_writer::empty_tag('input', array('type'=>'radio', 'name'=>'preset_time', 'id'=>'pt_monnext', 'value'=>'monthnext'));
82             $output .= html_writer::tag('label', get_string('monthnext', 'calendar'), array('for'=>'pt_monnext'));
83             $output .= html_writer::empty_tag('br');
84         }
85         $output .= html_writer::empty_tag('input', array('type'=>'radio', 'name'=>'preset_time', 'id'=>'pt_recupc', 'value'=>'recentupcoming'));
86         $output .= html_writer::tag('label', get_string('recentupcoming', 'calendar'), array('for'=>'pt_recupc'));
87         $output .= html_writer::empty_tag('br');
89         if ($CFG->calendar_customexport) {
90             $a = new stdClass();
91             $now = time();
92             $time = $now - $CFG->calendar_exportlookback * DAYSECS;
93             $a->timestart = userdate($time, get_string('strftimedatefullshort', 'langconfig'));
94             $time = $now + $CFG->calendar_exportlookahead * DAYSECS;
95             $a->timeend = userdate($time, get_string('strftimedatefullshort', 'langconfig'));
96             $output .= html_writer::empty_tag('input', array('type' => 'radio', 'name' => 'preset_time', 'id' => 'pt_custom', 'value' => 'custom'));
97             $output .= html_writer::tag('label', get_string('customexport', 'calendar', $a), array('for' => 'pt_custom'));
98             $output .= html_writer::empty_tag('br');
99         }
101         $output .= html_writer::end_tag('div');
102         $output .= html_writer::start_tag('div', array('class'=>'rightalign'));
103         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'cal_d', 'value'=>''));
104         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'cal_m', 'value'=>''));
105         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'cal_y', 'value'=>''));
106         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'userid', 'value'=>$userid));
107         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'authtoken', 'value'=>$authtoken));
109         $output .= html_writer::empty_tag('input', array('type'=>'submit', 'name' => 'generateurl', 'id'=>'generateurl', 'value'=>get_string('generateurlbutton', 'calendar')));
110         $output .= html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('exportbutton', 'calendar')));
112         $output .= html_writer::end_tag('div');
114         $output .= html_writer::end_tag('form');
115         $output .= html_writer::end_tag('fieldset');
117         $output .= html_writer::start_tag('div', array('id'=>'urlbox', 'style'=>'display:none;'));
118         $output .= html_writer::tag('p', get_string('urlforical', 'calendar'));
119         $output .= html_writer::tag('div', '', array('id'=>'url', 'style'=>'overflow:scroll;width:650px;'));
120         $output .= html_writer::end_tag('div');
122         return $output;
123     }
125     /**
126      * Starts the standard layout for the page
127      *
128      * @return string
129      */
130     public function start_layout() {
131         return html_writer::start_tag('div', array('class'=>'maincalendar'));
132     }
134     /**
135      * Creates the remainder of the layout
136      *
137      * @return string
138      */
139     public function complete_layout() {
140         return html_writer::end_tag('div');
141     }
143     /**
144      * Produces the content for the filters block (pretend block)
145      *
146      * @param int $courseid
147      * @param int $day
148      * @param int $month
149      * @param int $year
150      * @param int $view
151      * @param int $courses
152      * @return string
153      */
154     public function fake_block_filters($courseid, $day, $month, $year, $view, $courses) {
155         $returnurl = $this->page->url;
156         $returnurl->param('course', $courseid);
157         return html_writer::tag('div', calendar_filter_controls($returnurl), array('class'=>'calendar_filters filters'));
158     }
160     /**
161      * Produces the content for the three months block (pretend block)
162      *
163      * This includes the previous month, the current month, and the next month
164      *
165      * @param calendar_information $calendar
166      * @return string
167      */
168     public function fake_block_threemonths(calendar_information $calendar) {
170         list($prevmon, $prevyr) = calendar_sub_month($calendar->month, $calendar->year);
171         list($nextmon, $nextyr) = calendar_add_month($calendar->month, $calendar->year);
173         $content  = html_writer::start_tag('div', array('class'=>'minicalendarblock'));
174         $content .= calendar_get_mini( $calendar->courses, $calendar->groups, $calendar->users, $prevmon, $prevyr, 'display', $calendar->courseid);
175         $content .= html_writer::end_tag('div');
176         $content .= html_writer::start_tag('div', array('class'=>'minicalendarblock'));
177         $content .= calendar_get_mini($calendar->courses, $calendar->groups, $calendar->users, $calendar->month, $calendar->year, 'display', $calendar->courseid);
178         $content .= html_writer::end_tag('div');
179         $content .= html_writer::start_tag('div', array('class'=>'minicalendarblock'));
180         $content .= calendar_get_mini($calendar->courses, $calendar->groups, $calendar->users, $nextmon, $nextyr, 'display', $calendar->courseid);
181         $content .= html_writer::end_tag('div');
182         return $content;
183     }
185     /**
186      * Adds a pretent calendar block
187      *
188      * @param block_contents $bc
189      * @param mixed $pos BLOCK_POS_RIGHT | BLOCK_POS_LEFT
190      */
191     public function add_pretend_calendar_block(block_contents $bc, $pos=BLOCK_POS_RIGHT) {
192         $this->page->blocks->add_fake_block($bc, $pos);
193     }
195     /**
196      * Creates a button to add a new event
197      *
198      * @param int $courseid
199      * @param int $day
200      * @param int $month
201      * @param int $year
202      * @return string
203      */
204     protected function add_event_button($courseid, $day=null, $month=null, $year=null) {
205         $output = html_writer::start_tag('div', array('class'=>'buttons'));
206         $output .= html_writer::start_tag('form', array('action'=>CALENDAR_URL.'event.php', 'method'=>'get'));
207         $output .= html_writer::start_tag('div');
208         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'action', 'value'=>'new'));
209         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'course', 'value'=>$courseid));
210         if ($day !== null) {
211             $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'cal_d', 'value'=>$day));
212         }
213         if ($month !== null) {
214             $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'cal_m', 'value'=>$month));
215         }
216         if ($year !== null) {
217             $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'cal_y', 'value'=>$year));
218         }
219         $output .= html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('newevent', 'calendar')));
220         $output .= html_writer::end_tag('div');
221         $output .= html_writer::end_tag('form');
222         $output .= html_writer::end_tag('div');
223         return $output;
224     }
226     /**
227      * Displays the calendar for a single day
228      *
229      * @param calendar_information $calendar
230      * @return string
231      */
232     public function show_day(calendar_information $calendar, moodle_url $returnurl = null) {
234         if ($returnurl === null) {
235             $returnurl = $this->page->url;
236         }
238         $calendar->checkdate();
239         $events = calendar_get_upcoming($calendar->courses, $calendar->groups, $calendar->users, 1, 100, $calendar->timestamp_today());
241         $output  = html_writer::start_tag('div', array('class'=>'header'));
242         if (calendar_user_can_add_event($calendar->course)) {
243             $output .= $this->add_event_button($calendar->course->id, $calendar->day, $calendar->month, $calendar->year);
244         }
245         //$output .= html_writer::tag('label', get_string('dayview', 'calendar'), array('for'=>'cal_course_flt_jump'));
246         $output .= $this->course_filter_selector($returnurl, get_string('dayview', 'calendar'));
247         $output .= html_writer::end_tag('div');
248         // Controls
249         $output .= html_writer::tag('div', calendar_top_controls('day', array('id' => $calendar->courseid, 'd' => $calendar->day, 'm' => $calendar->month, 'y' => $calendar->year)), array('class'=>'controls'));
251         if (empty($events)) {
252             // There is nothing to display today.
253             $output .= $this->output->heading(get_string('daywithnoevents', 'calendar'), 3);
254         } else {
255             $output .= html_writer::start_tag('div', array('class'=>'eventlist'));
256             $underway = array();
257             // First, print details about events that start today
258             foreach ($events as $event) {
259                 $event = new calendar_event($event);
260                 $event->calendarcourseid = $calendar->courseid;
261                 if ($event->timestart >= $calendar->timestamp_today() && $event->timestart <= $calendar->timestamp_tomorrow()-1) {  // Print it now
262                     $event->time = calendar_format_event_time($event, time(), null, false, $calendar->timestamp_today());
263                     $output .= $this->event($event);
264                 } else {                                                                 // Save this for later
265                     $underway[] = $event;
266                 }
267             }
269             // Then, show a list of all events that just span this day
270             if (!empty($underway)) {
271                 $output .= $this->output->heading(get_string('spanningevents', 'calendar'), 3);
272                 foreach ($underway as $event) {
273                     $event->time = calendar_format_event_time($event, time(), null, false, $calendar->timestamp_today());
274                     $output .= $this->event($event);
275                 }
276             }
278             $output .= html_writer::end_tag('div');
279         }
281         return $output;
282     }
284     /**
285      * Displays an event
286      *
287      * @param calendar_event $event
288      * @param bool $showactions
289      * @return string
290      */
291     public function event(calendar_event $event, $showactions=true) {
292         global $CFG;
294         $event = calendar_add_event_metadata($event);
296         $anchor  = html_writer::tag('a', '', array('name'=>'event_'.$event->id));
298         $table = new html_table();
299         $table->attributes = array('class'=>'event', 'cellspacing'=>'0');
300         $table->data = array(
301             0 => new html_table_row(),
302             1 => new html_table_row(),
303         );
305         if (!empty($event->icon)) {
306             $table->data[0]->cells[0] = new html_table_cell($anchor.$event->icon);
307         } else {
308             $table->data[0]->cells[0] = new html_table_cell($anchor.$this->output->spacer(array('height'=>16, 'width'=>16, 'br'=>true)));
309         }
310         $table->data[0]->cells[0]->attributes['class'] .= ' picture';
312         $table->data[0]->cells[1] = new html_table_cell();
313         $table->data[0]->cells[1]->attributes['class'] .= ' topic';
314         if (!empty($event->referer)) {
315             $table->data[0]->cells[1]->text .= html_writer::tag('div', $event->referer, array('class'=>'referer'));
316         } else {
317             $table->data[0]->cells[1]->text .= html_writer::tag('div', $event->name, array('class'=>'name'));
318         }
319         if (!empty($event->courselink)) {
320             $table->data[0]->cells[1]->text .= html_writer::tag('div', $event->courselink, array('class'=>'course'));
321         }
322         // Show subscription source if needed.
323         if (!empty($event->subscription) && $CFG->calendar_showicalsource) {
324             if (!empty($event->subscription->url)) {
325                 $source = html_writer::link($event->subscription->url, get_string('subsource', 'calendar', $event->subscription));
326             } else {
327                 // File based ical.
328                 $source = get_string('subsource', 'calendar', $event->subscription);
329             }
330             $table->data[0]->cells[1]->text .= html_writer::tag('div', $source, array('class' => 'subscription'));
331         }
332         if (!empty($event->time)) {
333             $table->data[0]->cells[1]->text .= html_writer::tag('span', $event->time, array('class'=>'date'));
334         } else {
335             $table->data[0]->cells[1]->text .= html_writer::tag('span', calendar_time_representation($event->timestart), array('class'=>'date'));
336         }
338         $table->data[1]->cells[0] = new html_table_cell('&nbsp;');
339         $table->data[1]->cells[0]->attributes['class'] .= 'side';
341         $table->data[1]->cells[1] = new html_table_cell($event->description);
342         $table->data[1]->cells[1]->attributes['class'] .= ' description';
343         if (isset($event->cssclass)) {
344             $table->data[1]->cells[1]->attributes['class'] .= ' '.$event->cssclass;
345         }
347         if (calendar_edit_event_allowed($event) && $showactions) {
348             if (empty($event->cmid)) {
349                 $editlink = new moodle_url(CALENDAR_URL.'event.php', array('action'=>'edit', 'id'=>$event->id));
350                 $deletelink = new moodle_url(CALENDAR_URL.'delete.php', array('id'=>$event->id));
351                 if (!empty($event->calendarcourseid)) {
352                     $editlink->param('course', $event->calendarcourseid);
353                     $deletelink->param('course', $event->calendarcourseid);
354                 }
355             } else {
356                 $editlink = new moodle_url('/course/mod.php', array('update'=>$event->cmid, 'return'=>true, 'sesskey'=>sesskey()));
357                 $deletelink = null;
358             }
360             $commands  = html_writer::start_tag('div', array('class'=>'commands'));
361             $commands .= html_writer::start_tag('a', array('href'=>$editlink));
362             $commands .= html_writer::empty_tag('img', array('src'=>$this->output->pix_url('t/edit'), 'alt'=>get_string('tt_editevent', 'calendar'), 'title'=>get_string('tt_editevent', 'calendar')));
363             $commands .= html_writer::end_tag('a');
364             if ($deletelink != null) {
365                 $commands .= html_writer::start_tag('a', array('href'=>$deletelink));
366                 $commands .= html_writer::empty_tag('img', array('src'=>$this->output->pix_url('t/delete'), 'alt'=>get_string('tt_deleteevent', 'calendar'), 'title'=>get_string('tt_deleteevent', 'calendar')));
367                 $commands .= html_writer::end_tag('a');
368             }
369             $commands .= html_writer::end_tag('div');
370             $table->data[1]->cells[1]->text .= $commands;
371         }
372         return html_writer::table($table);
373     }
375     /**
376      * Displays a month in detail
377      *
378      * @param calendar_information $calendar
379      * @return string
380      */
381     public function show_month_detailed(calendar_information $calendar, moodle_url $returnurl  = null) {
382         global $CFG;
383         // MDL-18375, Multi-Calendar Support
384         global $CALENDARSYSTEM;
386         if (empty($returnurl)) {
387             $returnurl = $this->page->url;
388         }
390         $date = usergetdate(time());
392         $display = new stdClass;
393         $display->minwday = get_user_preferences('calendar_startwday', calendar_get_starting_weekday());
394         $display->maxwday = $display->minwday + 6;
395         $display->thismonth = ($date['mon'] == $calendar->month);
396         $display->maxdays = calendar_days_in_month($calendar->month, $calendar->year);
398         $startwday = 0;
399         if (get_user_timezone_offset() < 99) {
400             // We 'll keep these values as GMT here, and offset them when the time comes to query the db
401             $display->tstart = $CALENDARSYSTEM->gmmktime(0, 0, 0, $calendar->month, 1, $calendar->year); // This is GMT
402             $display->tend = $CALENDARSYSTEM->gmmktime(23, 59, 59, $calendar->month, $display->maxdays, $calendar->year); // GMT
403             $startwday = gmdate('w', $display->tstart); // $display->tstart is already GMT, so don't use date(): messes with server's TZ
404         } else {
405             // no timezone info specified
406             $display->tstart = $CALENDARSYSTEM->mktime(0, 0, 0, $calendar->month, 1, $calendar->year);
407             $display->tend = $CALENDARSYSTEM->mktime(23, 59, 59, $calendar->month, $display->maxdays, $calendar->year);
408             $startwday = date('w', $display->tstart); // $display->tstart not necessarily GMT, so use date()
409         }
411         // Align the starting weekday to fall in our display range
412         if ($startwday < $display->minwday) {
413             $startwday += 7;
414         }
416         // Get events from database
417         $events = calendar_get_events(usertime($display->tstart), usertime($display->tend), $calendar->users, $calendar->groups, $calendar->courses);
418         if (!empty($events)) {
419             foreach($events as $eventid => $event) {
420                 $event = new calendar_event($event);
421                 if (!empty($event->modulename)) {
422                     $cm = get_coursemodule_from_instance($event->modulename, $event->instance);
423                     if (!groups_course_module_visible($cm)) {
424                         unset($events[$eventid]);
425                     }
426                 }
427             }
428         }
430         // Extract information: events vs. time
431         calendar_events_by_day($events, $calendar->month, $calendar->year, $eventsbyday, $durationbyday, $typesbyday, $calendar->courses);
433         $output  = html_writer::start_tag('div', array('class'=>'header'));
434         if (calendar_user_can_add_event($calendar->course)) {
435             $output .= $this->add_event_button($calendar->course->id, null, $calendar->month, $calendar->year);
436         }
437         $output .= get_string('detailedmonthview', 'calendar').': '.$this->course_filter_selector($returnurl);
438         $output .= html_writer::end_tag('div', array('class'=>'header'));
439         // Controls
440         $output .= html_writer::tag('div', calendar_top_controls('month', array('id' => $calendar->courseid, 'm' => $calendar->month, 'y' => $calendar->year)), array('class'=>'controls'));
442         $days = calendar_get_days();
444         $table = new html_table();
445         $table->attributes = array('class'=>'calendarmonth calendartable');
446         $time = make_timestamp($calendar->year, $calendar->month);
447         $table->summary = get_string('calendarheading', 'calendar', userdate($time, get_string('strftimemonthyear')));
448         $table->data = array();
450         $header = new html_table_row();
451         $header->attributes = array('class'=>'weekdays');
452         $header->cells = array();
453         for($i = $display->minwday; $i <= $display->maxwday; ++$i) {
454             // This uses the % operator to get the correct weekday no matter what shift we have
455             // applied to the $display->minwday : $display->maxwday range from the default 0 : 6
456             $cell = new html_table_cell(get_string($days[$i % 7], 'calendar'));
457             $cell->header = true;
458             $header->cells[] = $cell;
459         }
461         // For the table display. $week is the row; $dayweek is the column.
462         $week = 1;
463         $dayweek = $startwday;
465         // Create an array of all the week days.
466         $wdays = array(0 => '<strong>'. get_string('sun', 'calendar'). '</strong>',
467                        1 => '<strong>'. get_string('mon', 'calendar'). '</strong>',
468                        2 => '<strong>'. get_string('tue', 'calendar'). '</strong>',
469                        3 => '<strong>'. get_string('wed', 'calendar'). '</strong>',
470                        4 => '<strong>'. get_string('thu', 'calendar'). '</strong>',
471                        5 => '<strong>'. get_string('fri', 'calendar'). '</strong>',
472                        6 => '<strong>'. get_string('sat', 'calendar'). '</strong>');
474         // Loop only if the day offset is greater than 0.
475         // This loop involves shifting the days around until the desired start day
476         // is at the start of the array.
477         $daycount = 0;
478         while ($display->minwday > $daycount++) {
479             $wdays_end = array_shift($wdays);
480             array_push($wdays, $wdays_end);
481         }
483         // Now we set the (modified) array to the table header to be displayed.
484         $table->head = $wdays;
486         $row = new html_table_row(array());
488         // Paddding (the first week may have blank days in the beginning)
489         for($i = $display->minwday; $i < $startwday; ++$i) {
490             $cell = new html_table_cell('&nbsp;');
491             $cell->attributes = array('class'=>'nottoday dayblank');
492             $row->cells[] = $cell;
493         }
495         // Now display all the calendar
496         $weekend = CALENDAR_DEFAULT_WEEKEND;
497         if (isset($CFG->calendar_weekend)) {
498             $weekend = intval($CFG->calendar_weekend);
499         }
501         for ($calendar->day = 1; $calendar->day <= $display->maxdays; ++$calendar->day, ++$dayweek) {
502             if($dayweek > $display->maxwday) {
503                 // We need to change week (table row)
504                 $table->data[] = $row;
505                 $row = new html_table_row(array());
506                 $dayweek = $display->minwday;
507                 ++$week;
508             }
510             // Reset vars
511             $cell = new html_table_cell();
512             $dayhref = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'day', 'course'=>$calendar->courseid)), $calendar->day, $calendar->month, $calendar->year);
514             $cellclasses = array();
516             if ($weekend & (1 << ($dayweek % 7))) {
517                 // Weekend. This is true no matter what the exact range is.
518                 $cellclasses[] = 'weekend';
519             }
521             // Special visual fx if an event is defined
522             if (isset($eventsbyday[$calendar->day])) {
523                 if(count($eventsbyday[$calendar->day]) == 1) {
524                     $title = get_string('oneevent', 'calendar');
525                 } else {
526                     $title = get_string('manyevents', 'calendar', count($eventsbyday[$calendar->day]));
527                 }
528                 $cell->text = html_writer::tag('div', html_writer::link($dayhref, $calendar->day, array('title'=>$title)), array('class'=>'day'));
529             } else {
530                 $cell->text = html_writer::tag('div', $calendar->day, array('class'=>'day'));
531             }
533             // Special visual fx if an event spans many days
534             $durationclass = false;
535             if (isset($typesbyday[$calendar->day]['durationglobal'])) {
536                 $durationclass = 'duration_global';
537             } else if (isset($typesbyday[$calendar->day]['durationcourse'])) {
538                 $durationclass = 'duration_course';
539             } else if (isset($typesbyday[$calendar->day]['durationgroup'])) {
540                 $durationclass = 'duration_group';
541             } else if (isset($typesbyday[$calendar->day]['durationuser'])) {
542                 $durationclass = 'duration_user';
543             }
544             if ($durationclass) {
545                 $cellclasses[] = 'duration';
546                 $cellclasses[] = $durationclass;
547             }
549             // Special visual fx for today
550             if ($display->thismonth && $calendar->day == $date['mday']) {
551                 $cellclasses[] = 'day today';
552             } else {
553                 $cellclasses[] = 'day nottoday';
554             }
555             $cell->attributes = array('class'=>join(' ',$cellclasses));
557             if (isset($eventsbyday[$calendar->day])) {
558                 $cell->text .= html_writer::start_tag('ul', array('class'=>'events-new'));
559                 foreach($eventsbyday[$calendar->day] as $eventindex) {
560                     // If event has a class set then add it to the event <li> tag
561                     $attributes = array();
562                     if (!empty($events[$eventindex]->class)) {
563                         $attributes['class'] = $events[$eventindex]->class;
564                     }
565                     $dayhref->set_anchor('event_'.$events[$eventindex]->id);
566                     $link = html_writer::link($dayhref, format_string($events[$eventindex]->name, true));
567                     $cell->text .= html_writer::tag('li', $link, $attributes);
568                 }
569                 $cell->text .= html_writer::end_tag('ul');
570             }
571             if (isset($durationbyday[$calendar->day])) {
572                 $cell->text .= html_writer::start_tag('ul', array('class'=>'events-underway'));
573                 foreach($durationbyday[$calendar->day] as $eventindex) {
574                     $cell->text .= html_writer::tag('li', '['.format_string($events[$eventindex]->name,true).']', array('class'=>'events-underway'));
575                 }
576                 $cell->text .= html_writer::end_tag('ul');
577             }
578             $row->cells[] = $cell;
579         }
581         // Paddding (the last week may have blank days at the end)
582         for($i = $dayweek; $i <= $display->maxwday; ++$i) {
583             $cell = new html_table_cell('&nbsp;');
584             $cell->attributes = array('class'=>'nottoday dayblank');
585             $row->cells[] = $cell;
586         }
587         $table->data[] = $row;
588         $output .= html_writer::table($table);
590         return $output;
591     }
593     /**
594      * Displays a filter selection table
595      *
596      * @param calendar_information $calendar
597      * @return string
598      * @deprecated since Moodle 2.4 MDL-32309
599      * @see calendar_filter_controls()
600      */
601     protected function filter_selection_table(calendar_information $calendar, moodle_url $returnurl = null) {
602         global $SESSION;
603         debugging('Method core_calendar_renderer::filter_selection_table() is deprecated, please use '.
604                 'calendar_filter_controls() instead', DEBUG_DEVELOPER);
606         if ($returnurl === null) {
607             $returnurl = $this->page->url;
608         }
610         $output  = html_writer::start_tag('div', array('class'=>'filters'));
611         $output .= html_writer::start_tag('table');
612         $output .= html_writer::start_tag('tr');
614         // Global events
615         $link = new moodle_url(CALENDAR_URL.'set.php', array('var' => 'showglobal', 'return' => base64_encode($returnurl->out(false)), 'sesskey'=>sesskey()));
616         $strglobalevents = get_string('globalevents', 'calendar');
617         if (calendar_show_event_type(CALENDAR_EVENT_GLOBAL)) {
618             $output .= html_writer::tag('td', '', array('class'=>'calendar_event_global', 'style'=>'width:8px;'));
619             $output .= html_writer::tag('td', html_writer::tag('strong', $strglobalevents).' '.get_string('shown', 'calendar').' ('.html_writer::link($link, get_string('clickhide', 'calendar').'<span class="accesshide">'.$strglobalevents.'</span>').')');
620         } else {
621             $output .= html_writer::tag('td', '', array('style'=>'width:8px;'));
622             $output .= html_writer::tag('td', html_writer::tag('strong', $strglobalevents).' '.get_string('hidden', 'calendar').' ('.html_writer::link($link, get_string('clickshow', 'calendar').'<span class="accesshide">'.$strglobalevents.'</span>').')');
623         }
625         // Course events
626         $link = new moodle_url(CALENDAR_URL.'set.php', array('var'=>'showcourses', 'return' => base64_encode($returnurl->out(false)), 'sesskey'=>sesskey()));
627         $strcourseevents = get_string('courseevents', 'calendar');
628         if (calendar_show_event_type(CALENDAR_EVENT_COURSE)) {
629             $output .= html_writer::tag('td', '', array('class'=>'calendar_event_course', 'style'=>'width:8px;'));
630             $output .= html_writer::tag('td', html_writer::tag('strong', $strcourseevents).' '.get_string('shown', 'calendar').' ('.html_writer::link($link, get_string('clickhide', 'calendar').'<span class="accesshide">'.$strcourseevents.'</span>').')');
631         } else {
632             $output .= html_writer::tag('td', '', array('style'=>'width:8px;'));
633             $output .= html_writer::tag('td', html_writer::tag('strong', $strcourseevents).' '.get_string('hidden', 'calendar').' ('.html_writer::link($link, get_string('clickshow', 'calendar').'<span class="accesshide">'.$strcourseevents.'</span>').')');
634         }
635         $output .= html_writer::end_tag('tr');
637         if(isloggedin() && !isguestuser()) {
638             $output .= html_writer::start_tag('tr');
639             // Group events
640             $link = new moodle_url(CALENDAR_URL.'set.php', array('var'=>'showgroups', 'return' => base64_encode($returnurl->out(false)), 'sesskey'=>sesskey()));
641             $strgroupevents = get_string('groupevents', 'calendar');
642             if (calendar_show_event_type(CALENDAR_EVENT_GROUP)) {
643                 $output .= html_writer::tag('td', '', array('class'=>'calendar_event_group', 'style'=>'width:8px;'));
644                 $output .= html_writer::tag('td', html_writer::tag('strong', $strgroupevents).' '.get_string('shown', 'calendar').' ('.html_writer::link($link, get_string('clickhide', 'calendar').'<span class="accesshide">'.$strgroupevents.'</span>').')');
645             } else {
646                 $output .= html_writer::tag('td', '', array('style'=>'width:8px;'));
647                 $output .= html_writer::tag('td', html_writer::tag('strong', $strgroupevents).' '.get_string('hidden', 'calendar').' ('.html_writer::link($link, get_string('clickshow', 'calendar').'<span class="accesshide">'.$strgroupevents.'</span>').')');
648             }
649             // User events
650             $link = new moodle_url(CALENDAR_URL.'set.php', array('var'=>'showuser', 'return' => base64_encode($returnurl->out(false)), 'sesskey'=>sesskey()));
651             $struserevents = get_string('userevents', 'calendar');
652             if (calendar_show_event_type(CALENDAR_EVENT_USER)) {
653                 $output .= html_writer::tag('td', '', array('class'=>'calendar_event_user', 'style'=>'width:8px;'));
654                 $output .= html_writer::tag('td', html_writer::tag('strong', $struserevents).' '.get_string('shown', 'calendar').' ('.html_writer::link($link, get_string('clickhide', 'calendar').'<span class="accesshide">'.$struserevents.'</span>').')');
655             } else {
656                 $output .= html_writer::tag('td', '', array('style'=>'width:8px;'));
657                 $output .= html_writer::tag('td', html_writer::tag('strong', $struserevents).' '.get_string('hidden', 'calendar').' ('.html_writer::link($link, get_string('clickshow', 'calendar').'<span class="accesshide">'.$struserevents.'</span>').')');
658             }
659             $output .= html_writer::end_tag('tr');
660         }
661         $output .= html_writer::end_tag('table');
662         $output .= html_writer::end_tag('div');
663         return $output;
664     }
666     /**
667      * Displays upcoming events
668      *
669      * @param calendar_information $calendar
670      * @param int $futuredays
671      * @param int $maxevents
672      * @return string
673      */
674     public function show_upcoming_events(calendar_information $calendar, $futuredays, $maxevents, moodle_url $returnurl = null) {
676         if ($returnurl === null) {
677             $returnurl = $this->page->url;
678         }
680         $events = calendar_get_upcoming($calendar->courses, $calendar->groups, $calendar->users, $futuredays, $maxevents);
682         $output  = html_writer::start_tag('div', array('class'=>'header'));
683         if (calendar_user_can_add_event($calendar->course)) {
684             $output .= $this->add_event_button($calendar->course->id);
685         }
686         $output .= html_writer::tag('label', get_string('upcomingevents', 'calendar'), array('for'=>'cal_course_flt_jump'));
687         $output .= $this->course_filter_selector($returnurl);
688         $output .= html_writer::end_tag('div');
690         if ($events) {
691             $output .= html_writer::start_tag('div', array('class'=>'eventlist'));
692             foreach ($events as $event) {
693                 // Convert to calendar_event object so that we transform description
694                 // accordingly
695                 $event = new calendar_event($event);
696                 $event->calendarcourseid = $calendar->courseid;
697                 $output .= $this->event($event);
698             }
699             $output .= html_writer::end_tag('div');
700         } else {
701             $output .= $this->output->heading(get_string('noupcomingevents', 'calendar'));
702         }
704         return $output;
705     }
707     /**
708      * Displays a course filter selector
709      *
710      * @param array $getvars
711      * @return string
712      */
713     protected function course_filter_selector(moodle_url $returnurl, $label=null) {
714         global $USER, $SESSION, $CFG;
716         if (!isloggedin() or isguestuser()) {
717             return '';
718         }
720         if (has_capability('moodle/calendar:manageentries', context_system::instance()) && !empty($CFG->calendar_adminseesall)) {
721             $courses = get_courses('all', 'c.shortname','c.id,c.shortname');
722         } else {
723             $courses = enrol_get_my_courses();
724         }
726         unset($courses[SITEID]);
728         $courseoptions = array();
729         $courseoptions[SITEID] = get_string('fulllistofcourses');
730         foreach ($courses as $course) {
731             $coursecontext = context_course::instance($course->id);
732             $courseoptions[$course->id] = format_string($course->shortname, true, array('context' => $coursecontext));
733         }
735         if ($this->page->course->id !== SITEID) {
736             $selected = $this->page->course->id;
737         } else {
738             $selected = '';
739         }
740         $select = new single_select(new moodle_url(CALENDAR_URL.'set.php', array('return' => base64_encode($returnurl->out(false)), 'var' => 'setcourse', 'sesskey'=>sesskey())), 'id', $courseoptions, $selected, null);
741         $select->class = 'cal_courses_flt';
742         if ($label !== null) {
743             $select->set_label($label);
744         } else {
745             $select->set_label(get_string('listofcourses'), array('class' => 'accesshide'));
746         }
747         return $this->output->render($select);
748     }
750     /**
751      * Renders a table containing information about calendar subscriptions.
752      *
753      * @param int $courseid
754      * @param array $subscriptions
755      * @param string $importresults
756      * @return string
757      */
758     public function subscription_details($courseid, $subscriptions, $importresults = '') {
759         $table = new html_table();
760         $table->head  = array(
761             get_string('colcalendar', 'calendar'),
762             get_string('collastupdated', 'calendar'),
763             get_string('eventkind', 'calendar'),
764             get_string('colpoll', 'calendar'),
765             get_string('colactions', 'calendar')
766         );
767         $table->align = array('left', 'left', 'left', 'center');
768         $table->width = '100%';
769         $table->data  = array();
771         if (empty($subscriptions)) {
772             $cell = new html_table_cell(get_string('nocalendarsubscriptions', 'calendar'));
773             $cell->colspan = 4;
774             $table->data[] = new html_table_row(array($cell));
775         }
776         $strnever = new lang_string('never', 'calendar');
777         foreach ($subscriptions as $sub) {
778             $label = $sub->name;
779             if (!empty($sub->url)) {
780                 $label = html_writer::link($sub->url, $label);
781             }
782             if (empty($sub->lastupdated)) {
783                 $lastupdated = $strnever->out();
784             } else {
785                 $lastupdated = userdate($sub->lastupdated, get_string('strftimedatetimeshort', 'langconfig'));
786             }
788             $cell = new html_table_cell($this->subscription_action_form($sub, $courseid));
789             $cell->colspan = 2;
790             $type = $sub->eventtype . 'events';
792             $table->data[] = new html_table_row(array(
793                 new html_table_cell($label),
794                 new html_table_cell($lastupdated),
795                 new html_table_cell(get_string($type, 'calendar')),
796                 $cell
797             ));
798         }
800         $out  = $this->output->box_start('generalbox calendarsubs');
802         $out .= $importresults;
803         $out .= html_writer::table($table);
804         $out .= $this->output->box_end();
805         return $out;
806     }
808     /**
809      * Creates a form to perform actions on a given subscription.
810      *
811      * @param stdClass $subscription
812      * @param int $courseid
813      * @return string
814      */
815     protected function subscription_action_form($subscription, $courseid) {
816         // Assemble form for the subscription row.
817         $html = html_writer::start_tag('form', array('action' => new moodle_url('/calendar/managesubscriptions.php'), 'method' => 'post'));
818         if (empty($subscription->url)) {
819             // Don't update an iCal file, which has no URL.
820             $html .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'pollinterval', 'value' => '0'));
821         } else {
822             // Assemble pollinterval control.
823             $html .= html_writer::start_tag('div', array('style' => 'float:left;'));
824             $html .= html_writer::start_tag('select', array('name' => 'pollinterval'));
825             foreach (calendar_get_pollinterval_choices() as $k => $v) {
826                 $attributes = array();
827                 if ($k == $subscription->pollinterval) {
828                     $attributes['selected'] = 'selected';
829                 }
830                 $attributes['value'] = $k;
831                 $html .= html_writer::tag('option', $v, $attributes);
832             }
833             $html .= html_writer::end_tag('select');
834             $html .= html_writer::end_tag('div');
835         }
836         $html .= html_writer::start_tag('div', array('style' => 'float:right;'));
837         $html .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
838         $html .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'course', 'value' => $courseid));
839         $html .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'id', 'value' => $subscription->id));
840         if (!empty($subscription->url)) {
841             $html .= html_writer::tag('button', get_string('update'), array('type'  => 'submit', 'name' => 'action',
842                                                                             'value' => CALENDAR_SUBSCRIPTION_UPDATE));
843         }
844         $html .= html_writer::tag('button', get_string('remove'), array('type'  => 'submit', 'name' => 'action',
845                                                                         'value' => CALENDAR_SUBSCRIPTION_REMOVE));
846         $html .= html_writer::end_tag('div');
847         $html .= html_writer::end_tag('form');
848         return $html;
849     }